Skip to content

Latest commit

 

History

History
2987 lines (2942 loc) · 111 KB

fortios_firewall_consolidated_policy.rst

File metadata and controls

2987 lines (2942 loc) · 111 KB
Raw
source:fortios_firewall_consolidated_policy.py
orphan:

fortios_firewall_consolidated_policy -- Configure consolidated IPv4/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_consolidated feature and policy category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9

Tips

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

FortiOS Version Compatibility


v6.2.0 v6.2.3 v6.2.5 v6.2.7
fortios_firewall_consolidated_policy 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_consolidated_policy - Configure consolidated IPv4/IPv6 policies. type: dict more...
    v6.2.0 v6.2.3 v6.2.5 v6.2.7
    firewall_consolidated_policy yes yes yes yes
    • action - Policy action (allow/deny/ipsec). type: str choices: accept, deny, ipsec more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      action yes yes yes yes
      [accept] yes yes yes yes
      [deny] yes yes yes yes
      [ipsec] yes yes yes yes
    • application_list - Name of an existing Application list. Source application.list.name. type: str more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      application_list yes yes yes yes
    • auto_asic_offload - Enable/disable policy traffic ASIC offloading. type: str choices: enable, disable more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      auto_asic_offload yes yes yes yes
      [enable] yes yes yes yes
      [disable] yes yes yes yes
    • av_profile - Name of an existing Antivirus profile. Source antivirus.profile.name. type: str more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      av_profile yes yes yes yes
    • captive_portal_exempt - Enable exemption of some users from the captive portal. type: str choices: enable, disable more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      captive_portal_exempt yes yes yes yes
      [enable] yes yes yes yes
      [disable] yes yes yes yes
    • cifs_profile - Name of an existing CIFS profile. Source cifs.profile.name. type: str more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      cifs_profile yes yes yes yes
    • comments - Comment. type: str more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      comments 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.2.0 v6.2.3 v6.2.5 v6.2.7
      diffserv_forward yes yes yes yes
      [enable] yes yes yes yes
      [disable] 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.2.0 v6.2.3 v6.2.5 v6.2.7
      diffserv_reverse yes yes yes yes
      [enable] yes yes yes yes
      [disable] yes yes yes yes
    • diffservcode_forward - Change packet"s DiffServ to this value. type: str more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      diffservcode_forward yes yes yes yes
    • diffservcode_rev - Change packet"s reverse (reply) DiffServ to this value. type: str more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      diffservcode_rev yes yes yes yes
    • dlp_sensor - Name of an existing DLP sensor. Source dlp.sensor.name. type: str more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      dlp_sensor yes yes yes yes
    • dnsfilter_profile - Name of an existing DNS filter profile. Source dnsfilter.profile.name. type: str more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      dnsfilter_profile yes yes yes yes
    • dstaddr_negate - When enabled dstaddr specifies what the destination address must NOT be. type: str choices: enable, disable more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      dstaddr_negate yes yes yes yes
      [enable] yes yes yes yes
      [disable] yes yes yes yes
    • dstaddr4 - Destination IPv4 address name and address group names. type: list member_path: dstaddr4:name more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      dstaddr4 yes yes yes yes
      • 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...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7
        name yes yes yes yes
    • dstaddr6 - Destination IPv6 address name and address group names. type: list member_path: dstaddr6:name more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      dstaddr6 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.2.0 v6.2.3 v6.2.5 v6.2.7
        name yes yes yes yes
    • dstintf - Outgoing (egress) interface. type: list member_path: dstintf:name more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      dstintf yes yes yes yes
      • name - Interface name. Source system.interface.name system.zone.name. type: str required: true more...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7
        name yes yes yes yes
    • emailfilter_profile - Name of an existing email filter profile. Source emailfilter.profile.name. type: str more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      emailfilter_profile yes yes yes yes
    • fixedport - Enable to prevent source NAT from changing a session"s source port. type: str choices: enable, disable more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      fixedport yes yes yes yes
      [enable] yes yes yes yes
      [disable] yes yes yes yes
    • fsso_groups - Names of FSSO groups. type: list member_path: fsso_groups:name more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      fsso_groups 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.2.0 v6.2.3
      global_label no yes
    • groups - Names of user groups that can authenticate with this policy. type: list member_path: groups:name more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      groups yes yes yes yes
      • name - Group name. Source user.group.name. type: str required: true more...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7
        name yes yes yes yes
    • http_policy_redirect - Redirect HTTP(S) traffic to matching transparent web proxy policy. type: str choices: enable, disable more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      http_policy_redirect yes yes yes yes
      [enable] yes yes yes yes
      [disable] yes yes yes yes
    • icap_profile - Name of an existing ICAP profile. Source icap.profile.name. type: str more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      icap_profile 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.2.0 v6.2.3 v6.2.5 v6.2.7
      inbound yes yes yes yes
      [enable] yes yes yes yes
      [disable] yes yes yes yes
    • inspection_mode - Policy inspection mode (Flow/proxy). Default is Flow mode. type: str choices: proxy, flow more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      inspection_mode yes yes yes yes
      [proxy] yes yes yes yes
      [flow] yes yes yes yes
    • 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...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      internet_service yes yes yes yes
      [enable] yes yes yes yes
      [disable] yes yes yes yes
    • internet_service_custom - Custom Internet Service name. type: list member_path: internet_service_custom:name more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      internet_service_custom yes yes yes yes
      • name - Custom Internet Service name. Source firewall.internet-service-custom.name. type: str required: true more...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7
        name yes yes yes yes
    • internet_service_custom_group - Custom Internet Service group name. type: list member_path: internet_service_custom_group:name more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      internet_service_custom_group yes yes yes yes
      • name - Custom Internet Service group name. Source firewall.internet-service-custom-group.name. type: str required: true more...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7
        name yes yes yes yes
    • internet_service_group - Internet Service group name. type: list member_path: internet_service_group:name more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      internet_service_group yes yes yes yes
      • name - Internet Service group name. Source firewall.internet-service-group.name. type: str required: true more...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7
        name yes yes yes yes
    • internet_service_id - Internet Service ID. type: list member_path: internet_service_id:id more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      internet_service_id yes yes yes yes
      • id - Internet Service ID. Source firewall.internet-service.id. type: int required: true more...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7
        id yes yes yes yes
    • internet_service_negate - When enabled internet-service specifies what the service must NOT be. type: str choices: enable, disable more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      internet_service_negate yes yes yes yes
      [enable] yes yes yes yes
      [disable] yes yes yes yes
    • 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...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      internet_service_src yes yes yes yes
      [enable] yes yes yes yes
      [disable] yes yes yes yes
    • internet_service_src_custom - Custom Internet Service source name. type: list member_path: internet_service_src_custom:name more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      internet_service_src_custom yes yes yes yes
      • name - Custom Internet Service name. Source firewall.internet-service-custom.name. type: str required: true more...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7
        name yes yes yes yes
    • internet_service_src_custom_group - Custom Internet Service source group name. type: list member_path: internet_service_src_custom_group:name more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      internet_service_src_custom_group yes yes yes yes
      • name - Custom Internet Service group name. Source firewall.internet-service-custom-group.name. type: str required: true more...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7
        name yes yes yes yes
    • internet_service_src_group - Internet Service source group name. type: list member_path: internet_service_src_group:name more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      internet_service_src_group yes yes yes yes
      • name - Internet Service group name. Source firewall.internet-service-group.name. type: str required: true more...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7
        name yes yes yes yes
    • internet_service_src_id - Internet Service source ID. type: list member_path: internet_service_src_id:id more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      internet_service_src_id yes yes yes yes
      • id - Internet Service ID. Source firewall.internet-service.id. type: int required: true more...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7
        id yes yes yes yes
    • internet_service_src_negate - When enabled internet-service-src specifies what the service must NOT be. type: str choices: enable, disable more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      internet_service_src_negate yes yes yes yes
      [enable] yes yes yes yes
      [disable] yes yes yes yes
    • ippool - Enable to use IP Pools for source NAT. type: str choices: enable, disable more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      ippool yes yes yes yes
      [enable] yes yes yes yes
      [disable] yes yes yes yes
    • ips_sensor - Name of an existing IPS sensor. Source ips.sensor.name. type: str more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      ips_sensor yes yes yes yes
    • logtraffic - Enable or disable logging. Log all sessions or security profile sessions. type: str choices: all, utm, disable more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      logtraffic yes yes yes yes
      [all] yes yes yes yes
      [utm] yes yes yes yes
      [disable] yes yes yes yes
    • logtraffic_start - Record logs when a session starts. type: str choices: enable, disable more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      logtraffic_start yes yes yes yes
      [enable] yes yes yes yes
      [disable] yes yes yes yes
    • mms_profile - Name of an existing MMS profile. Source firewall.mms-profile.name. type: str more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      mms_profile yes yes yes yes
    • name - Policy name. type: str more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      name yes yes yes yes
    • nat - Enable/disable source NAT. type: str choices: enable, disable more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      nat yes yes yes yes
      [enable] yes yes yes yes
      [disable] 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.2.0 v6.2.3 v6.2.5 v6.2.7
      outbound yes yes yes yes
      [enable] yes yes yes yes
      [disable] yes yes yes yes
    • per_ip_shaper - Per-IP traffic shaper. Source firewall.shaper.per-ip-shaper.name. type: str more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      per_ip_shaper yes yes yes yes
    • policyid - Policy ID (0 - 4294967294). type: int required: true more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      policyid yes yes yes yes
    • poolname4 - IPv4 pool names. type: list member_path: poolname4:name more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      poolname4 yes yes yes yes
      • name - IPv4 pool name. Source firewall.ippool.name. type: str required: true more...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7
        name yes yes yes yes
    • poolname6 - IPv6 pool names. type: list member_path: poolname6:name more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      poolname6 yes yes yes yes
      • name - IPv6 pool name. Source firewall.ippool6.name. type: str required: true more...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7
        name yes yes yes yes
    • profile_group - Name of profile group. Source firewall.profile-group.name. type: str more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      profile_group yes yes yes yes
    • profile_protocol_options - Name of an existing Protocol options profile. Source firewall.profile-protocol-options.name. type: str more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      profile_protocol_options 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.2.0 v6.2.3 v6.2.5 v6.2.7
      profile_type yes yes yes yes
      [single] yes yes yes yes
      [group] yes yes yes yes
    • schedule - Schedule name. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name. type: str more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      schedule yes yes yes yes
    • service - Service and service group names. type: list member_path: service:name more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      service yes yes yes yes
      • name - Service name. Source firewall.service.custom.name firewall.service.group.name. type: str required: true more...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7
        name yes yes yes yes
    • service_negate - When enabled service specifies what the service must NOT be. type: str choices: enable, disable more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      service_negate yes yes yes yes
      [enable] yes yes yes yes
      [disable] yes yes yes yes
    • session_ttl - TTL in seconds for sessions accepted by this policy (0 means use the system ). type: int more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      session_ttl yes yes yes yes
    • srcaddr_negate - When enabled srcaddr specifies what the source address must NOT be. type: str choices: enable, disable more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      srcaddr_negate yes yes yes yes
      [enable] yes yes yes yes
      [disable] yes yes yes yes
    • srcaddr4 - Source IPv4 address name and address group names. type: list member_path: srcaddr4:name more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      srcaddr4 yes yes yes yes
      • name - Address name. Source firewall.address.name firewall.addrgrp.name system.external-resource.name. type: str required: true more...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7
        name yes yes yes yes
    • srcaddr6 - Source IPv6 address name and address group names. type: list member_path: srcaddr6:name more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      srcaddr6 yes yes yes yes
      • name - Address name. Source firewall.address6.name firewall.addrgrp6.name system.external-resource.name. type: str required: true more...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7
        name yes yes yes yes
    • srcintf - Incoming (ingress) interface. type: list member_path: srcintf:name more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      srcintf yes yes yes yes
      • name - Interface name. Source system.interface.name system.zone.name. type: str required: true more...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7
        name yes yes yes yes
    • ssh_filter_profile - Name of an existing SSH filter profile. Source ssh-filter.profile.name. type: str more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      ssh_filter_profile yes yes yes yes
    • ssh_policy_redirect - Redirect SSH traffic to matching transparent proxy policy. type: str choices: enable, disable more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      ssh_policy_redirect yes yes yes yes
      [enable] yes yes yes yes
      [disable] yes yes yes yes
    • ssl_ssh_profile - Name of an existing SSL SSH profile. Source firewall.ssl-ssh-profile.name. type: str more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      ssl_ssh_profile yes yes yes yes
    • status - Enable or disable this policy. type: str choices: enable, disable more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      status yes yes yes yes
      [enable] yes yes yes yes
      [disable] yes yes yes yes
    • tcp_mss_receiver - Receiver TCP maximum segment size (MSS). type: int more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      tcp_mss_receiver yes yes yes yes
    • tcp_mss_sender - Sender TCP maximum segment size (MSS). type: int more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      tcp_mss_sender yes yes yes yes
    • traffic_shaper - Traffic shaper. Source firewall.shaper.traffic-shaper.name. type: str more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      traffic_shaper yes yes yes yes
    • traffic_shaper_reverse - Reverse traffic shaper. Source firewall.shaper.traffic-shaper.name. type: str more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      traffic_shaper_reverse yes yes yes yes
    • users - Names of individual users that can authenticate with this policy. type: list member_path: users:name more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      users yes yes yes yes
      • name - User name. Source user.local.name. type: str required: true more...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7
        name yes yes yes yes
    • utm_status - Enable to add one or more security profiles (AV, IPS, etc.) to the firewall policy. type: str choices: enable, disable more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      utm_status yes yes yes yes
      [enable] yes yes yes yes
      [disable] yes yes yes yes
    • uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      uuid yes yes yes yes
    • voip_profile - Name of an existing VoIP profile. Source voip.profile.name. type: str more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      voip_profile 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.2.0 v6.2.3 v6.2.5 v6.2.7
      vpntunnel yes yes yes yes
    • waf_profile - Name of an existing Web application firewall profile. Source waf.profile.name. type: str more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      waf_profile yes yes yes yes
    • wanopt - Enable/disable WAN optimization. type: str choices: enable, disable more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      wanopt yes yes yes yes
      [enable] yes yes yes yes
      [disable] yes yes yes yes
    • wanopt_detection - WAN optimization auto-detection mode. type: str choices: active, passive, off more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      wanopt_detection yes yes yes yes
      [active] yes yes yes yes
      [passive] yes yes yes yes
      [off] yes yes yes yes
    • wanopt_passive_opt - WAN optimization passive mode options. This option decides what IP address will be used to connect to server. type: str choices: default, transparent, non-transparent more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      wanopt_passive_opt yes yes yes yes
      [default] yes yes yes yes
      [transparent] yes yes yes yes
      [non-transparent] yes yes yes yes
    • wanopt_peer - WAN optimization peer. Source wanopt.peer.peer-host-id. type: str more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      wanopt_peer yes yes yes yes
    • wanopt_profile - WAN optimization profile. Source wanopt.profile.name. type: str more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      wanopt_profile yes yes yes yes
    • webcache - Enable/disable web cache. type: str choices: enable, disable more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      webcache yes yes yes yes
      [enable] yes yes yes yes
      [disable] yes yes yes yes
    • webcache_https - Enable/disable web cache for HTTPS. type: str choices: disable, enable more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      webcache_https yes yes yes yes
      [disable] yes yes yes yes
      [enable] yes yes yes yes
    • webfilter_profile - Name of an existing Web filter profile. Source webfilter.profile.name. type: str more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      webfilter_profile yes yes yes yes
    • webproxy_forward_server - Webproxy forward server name. Source web-proxy.forward-server.name web-proxy.forward-server-group.name. type: str more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      webproxy_forward_server yes yes yes yes
    • webproxy_profile - Webproxy profile name. Source web-proxy.profile.name. type: str more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      webproxy_profile 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 consolidated IPv4/IPv6 policies.
    fortios_firewall_consolidated_policy:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_consolidated_policy:
        action: "accept"
        application_list: "<your_own_value> (source application.list.name)"
        auto_asic_offload: "enable"
        av_profile: "<your_own_value> (source antivirus.profile.name)"
        captive_portal_exempt: "enable"
        cifs_profile: "<your_own_value> (source cifs.profile.name)"
        comments: "<your_own_value>"
        diffserv_forward: "enable"
        diffserv_reverse: "enable"
        diffservcode_forward: "<your_own_value>"
        diffservcode_rev: "<your_own_value>"
        dlp_sensor: "<your_own_value> (source dlp.sensor.name)"
        dnsfilter_profile: "<your_own_value> (source dnsfilter.profile.name)"
        dstaddr_negate: "enable"
        dstaddr4:
         -
            name: "default_name_18 (source firewall.address.name firewall.addrgrp.name firewall.vip.name firewall.vipgrp.name system.external-resource.name)"
        dstaddr6:
         -
            name: "default_name_20 (source firewall.address6.name firewall.addrgrp6.name firewall.vip6.name firewall.vipgrp6.name system.external-resource
              .name)"
        dstintf:
         -
            name: "default_name_22 (source system.interface.name system.zone.name)"
        emailfilter_profile: "<your_own_value> (source emailfilter.profile.name)"
        fixedport: "enable"
        fsso_groups:
         -
            name: "default_name_26 (source user.adgrp.name)"
        global_label: "<your_own_value>"
        groups:
         -
            name: "default_name_29 (source user.group.name)"
        http_policy_redirect: "enable"
        icap_profile: "<your_own_value> (source icap.profile.name)"
        inbound: "enable"
        inspection_mode: "proxy"
        internet_service: "enable"
        internet_service_custom:
         -
            name: "default_name_36 (source firewall.internet-service-custom.name)"
        internet_service_custom_group:
         -
            name: "default_name_38 (source firewall.internet-service-custom-group.name)"
        internet_service_group:
         -
            name: "default_name_40 (source firewall.internet-service-group.name)"
        internet_service_id:
         -
            id:  "42 (source firewall.internet-service.id)"
        internet_service_negate: "enable"
        internet_service_src: "enable"
        internet_service_src_custom:
         -
            name: "default_name_46 (source firewall.internet-service-custom.name)"
        internet_service_src_custom_group:
         -
            name: "default_name_48 (source firewall.internet-service-custom-group.name)"
        internet_service_src_group:
         -
            name: "default_name_50 (source firewall.internet-service-group.name)"
        internet_service_src_id:
         -
            id:  "52 (source firewall.internet-service.id)"
        internet_service_src_negate: "enable"
        ippool: "enable"
        ips_sensor: "<your_own_value> (source ips.sensor.name)"
        logtraffic: "all"
        logtraffic_start: "enable"
        mms_profile: "<your_own_value> (source firewall.mms-profile.name)"
        name: "default_name_59"
        nat: "enable"
        outbound: "enable"
        per_ip_shaper: "<your_own_value> (source firewall.shaper.per-ip-shaper.name)"
        policyid: "2147483647"
        poolname4:
         -
            name: "default_name_65 (source firewall.ippool.name)"
        poolname6:
         -
            name: "default_name_67 (source firewall.ippool6.name)"
        profile_group: "<your_own_value> (source firewall.profile-group.name)"
        profile_protocol_options: "<your_own_value> (source firewall.profile-protocol-options.name)"
        profile_type: "single"
        schedule: "<your_own_value> (source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name)"
        service:
         -
            name: "default_name_73 (source firewall.service.custom.name firewall.service.group.name)"
        service_negate: "enable"
        session_ttl: "1382400"
        srcaddr_negate: "enable"
        srcaddr4:
         -
            name: "default_name_78 (source firewall.address.name firewall.addrgrp.name system.external-resource.name)"
        srcaddr6:
         -
            name: "default_name_80 (source firewall.address6.name firewall.addrgrp6.name system.external-resource.name)"
        srcintf:
         -
            name: "default_name_82 (source system.interface.name system.zone.name)"
        ssh_filter_profile: "<your_own_value> (source ssh-filter.profile.name)"
        ssh_policy_redirect: "enable"
        ssl_ssh_profile: "<your_own_value> (source firewall.ssl-ssh-profile.name)"
        status: "enable"
        tcp_mss_receiver: "32767"
        tcp_mss_sender: "32767"
        traffic_shaper: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
        traffic_shaper_reverse: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
        users:
         -
            name: "default_name_92 (source user.local.name)"
        utm_status: "enable"
        uuid: "<your_own_value>"
        voip_profile: "<your_own_value> (source voip.profile.name)"
        vpntunnel: "<your_own_value> (source vpn.ipsec.phase1.name vpn.ipsec.manualkey.name)"
        waf_profile: "<your_own_value> (source waf.profile.name)"
        wanopt: "enable"
        wanopt_detection: "active"
        wanopt_passive_opt: "default"
        wanopt_peer: "<your_own_value> (source wanopt.peer.peer-host-id)"
        wanopt_profile: "<your_own_value> (source wanopt.profile.name)"
        webcache: "enable"
        webcache_https: "disable"
        webfilter_profile: "<your_own_value> (source webfilter.profile.name)"
        webproxy_forward_server: "<your_own_value> (source web-proxy.forward-server.name web-proxy.forward-server-group.name)"
        webproxy_profile: "<your_own_value> (source web-proxy.profile.name)"

Return Values

Common return values are documented: 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.