Skip to content

Latest commit

 

History

History
2001 lines (1956 loc) · 91.8 KB

fortios_firewall_proxy_policy.rst

File metadata and controls

2001 lines (1956 loc) · 91.8 KB
Raw
source:fortios_firewall_proxy_policy.py
orphan:

fortios_firewall_proxy_policy -- Configure proxy 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 proxy_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.14

Tips

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

FortiOS Version Compatibility


Supported Version Ranges
fortios_firewall_proxy_policy v6.0.0 -> latest

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_proxy_policy - Configure proxy policies. type: dict more...
    Supported Version Ranges
    firewall_proxy_policy v6.0.0 -> latest
    • access_proxy - IPv4 access proxy. type: list member_path: access_proxy:name more...
      Supported Version Ranges
      access_proxy v7.0.0 -> latest
      • name - Access Proxy name. Source firewall.access-proxy.name. type: str required: true more...
        Supported Version Ranges
        name v7.0.0 -> latest
    • access_proxy6 - IPv6 access proxy. type: list member_path: access_proxy6:name more...
      Supported Version Ranges
      access_proxy6 v7.0.1 -> latest
      • name - Access proxy name. Source firewall.access-proxy6.name. type: str required: true more...
        Supported Version Ranges
        name v7.0.1 -> latest
    • action - Accept or deny traffic matching the policy parameters. type: str choices: accept, deny, redirect more...
      Supported Version Ranges
      action v6.0.0 -> latest
      [accept] v6.0.0 -> latest
      [deny] v6.0.0 -> latest
      [redirect] v6.0.0 -> latest
    • application_list - Name of an existing Application list. Source application.list.name. type: str more...
      Supported Version Ranges
      application_list v6.0.0 -> latest
    • av_profile - Name of an existing Antivirus profile. Source antivirus.profile.name. type: str more...
      Supported Version Ranges
      av_profile v6.0.0 -> latest
    • block_notification - Enable/disable block notification. type: str choices: enable, disable more...
      Supported Version Ranges
      block_notification v7.0.4 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • casb_profile - Name of an existing CASB profile. Source casb.profile.name. type: str more...
      Supported Version Ranges
      casb_profile v7.4.1 -> latest
    • cifs_profile - Name of an existing CIFS profile. Source cifs.profile.name. type: str more...
      Supported Version Ranges
      cifs_profile v6.2.0 -> latest
    • comments - Optional comments. type: str more...
      Supported Version Ranges
      comments v6.0.0 -> latest
    • decrypted_traffic_mirror - Decrypted traffic mirror. Source firewall.decrypted-traffic-mirror.name. type: str more...
      Supported Version Ranges
      decrypted_traffic_mirror v6.4.0 -> latest
    • detect_https_in_http_request - Enable/disable detection of HTTPS in HTTP request. type: str choices: enable, disable more...
      Supported Version Ranges
      detect_https_in_http_request v7.4.1 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • device_ownership - When enabled, the ownership enforcement will be done at policy level. type: str choices: enable, disable more...
      Supported Version Ranges
      device_ownership v7.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • disclaimer - Web proxy disclaimer setting: by domain, policy, or user. type: str choices: disable, domain, policy, user more...
      Supported Version Ranges
      disclaimer v6.0.0 -> latest
      [disable] v6.0.0 -> latest
      [domain] v6.0.0 -> latest
      [policy] v6.0.0 -> latest
      [user] v6.0.0 -> latest
    • dlp_profile - Name of an existing DLP profile. Source dlp.profile.name. type: str more...
      Supported Version Ranges
      dlp_profile v7.2.0 -> latest
    • dlp_sensor - Name of an existing DLP sensor. Source dlp.sensor.name. type: str more...
      Supported Version Ranges
      dlp_sensor v6.0.0 -> v7.0.12
    • dstaddr - Destination address objects. type: list member_path: dstaddr:name more...
      Supported Version Ranges
      dstaddr v6.0.0 -> latest
      • name - Address name. Source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name firewall.vip.name firewall.vipgrp.name system.external-resource.name. type: str required: true more...
        Supported Version Ranges
        name v6.0.0 -> latest
    • dstaddr_negate - When enabled, destination addresses match against any address EXCEPT the specified destination addresses. type: str choices: enable, disable more...
      Supported Version Ranges
      dstaddr_negate v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • dstaddr6 - IPv6 destination address objects. type: list member_path: dstaddr6:name more...
      Supported Version Ranges
      dstaddr6 v6.0.0 -> latest
      • 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 -> latest
    • dstintf - Destination interface names. type: list member_path: dstintf:name more...
      Supported Version Ranges
      dstintf v6.0.0 -> latest
      • name - Interface name. Source system.interface.name system.zone.name system.sdwan.zone.name. type: str required: true more...
        Supported Version Ranges
        name v6.0.0 -> latest
    • emailfilter_profile - Name of an existing email filter profile. Source emailfilter.profile.name. type: str more...
      Supported Version Ranges
      emailfilter_profile v6.2.0 -> latest
    • file_filter_profile - Name of an existing file-filter profile. Source file-filter.profile.name. type: str more...
      Supported Version Ranges
      file_filter_profile v6.4.0 -> latest
    • global_label - Global web-based manager visible label. type: str more...
      Supported Version Ranges
      global_label v6.0.0 -> v6.0.11 v6.2.3 -> v6.2.3
    • groups - Names of group objects. type: list member_path: groups:name more...
      Supported Version Ranges
      groups v6.0.0 -> latest
      • name - Group name. Source user.group.name. type: str required: true more...
        Supported Version Ranges
        name v6.0.0 -> latest
    • http_tunnel_auth - Enable/disable HTTP tunnel authentication. type: str choices: enable, disable more...
      Supported Version Ranges
      http_tunnel_auth v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • icap_profile - Name of an existing ICAP profile. Source icap.profile.name. type: str more...
      Supported Version Ranges
      icap_profile v6.0.0 -> latest
    • internet_service - Enable/disable use of Internet Services for this policy. If enabled, destination address and service are not used. type: str choices: enable, disable more...
      Supported Version Ranges
      internet_service v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • internet_service_custom - Custom Internet Service name. type: list member_path: internet_service_custom:name more...
      Supported Version Ranges
      internet_service_custom v6.0.0 -> latest
      • name - Custom Internet Service name. Source firewall.internet-service-custom.name. type: str required: true more...
        Supported Version Ranges
        name v6.0.0 -> latest
    • internet_service_custom_group - Custom Internet Service group name. type: list member_path: internet_service_custom_group:name more...
      Supported Version Ranges
      internet_service_custom_group v6.2.0 -> latest
      • name - Custom Internet Service group name. Source firewall.internet-service-custom-group.name. type: str required: true more...
        Supported Version Ranges
        name v6.2.0 -> latest
    • internet_service_group - Internet Service group name. type: list member_path: internet_service_group:name more...
      Supported Version Ranges
      internet_service_group v6.2.0 -> latest
      • name - Internet Service group name. Source firewall.internet-service-group.name. type: str required: true more...
        Supported Version Ranges
        name v6.2.0 -> latest
    • internet_service_id - Internet Service ID. type: list member_path: internet_service_id:id more...
      Supported Version Ranges
      internet_service_id v6.0.0 -> v6.2.7
      • id - Internet Service ID. see Notes. Source firewall.internet-service.id. type: int required: true more...
        Supported Version Ranges
        id v6.0.0 -> v6.2.7
    • internet_service_name - Internet Service name. type: list member_path: internet_service_name:name more...
      Supported Version Ranges
      internet_service_name v6.4.0 -> latest
      • name - Internet Service name. Source firewall.internet-service-name.name. type: str required: true more...
        Supported Version Ranges
        name v6.4.0 -> latest
    • internet_service_negate - When enabled, Internet Services match against any internet service EXCEPT the selected Internet Service. type: str choices: enable, disable more...
      Supported Version Ranges
      internet_service_negate v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • internet_service6 - Enable/disable use of Internet Services IPv6 for this policy. If enabled, destination IPv6 address and service are not used. type: str choices: enable, disable more...
      Supported Version Ranges
      internet_service6 v7.2.4 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • internet_service6_custom - Custom Internet Service IPv6 name. type: list member_path: internet_service6_custom:name more...
      Supported Version Ranges
      internet_service6_custom v7.2.4 -> latest
      • name - Custom Internet Service IPv6 name. Source firewall.internet-service-custom.name. type: str required: true more...
        Supported Version Ranges
        name v7.2.4 -> latest
    • internet_service6_custom_group - Custom Internet Service IPv6 group name. type: list member_path: internet_service6_custom_group:name more...
      Supported Version Ranges
      internet_service6_custom_group v7.2.4 -> latest
      • name - Custom Internet Service IPv6 group name. Source firewall.internet-service-custom-group.name. type: str required: true more...
        Supported Version Ranges
        name v7.2.4 -> latest
    • internet_service6_group - Internet Service IPv6 group name. type: list member_path: internet_service6_group:name more...
      Supported Version Ranges
      internet_service6_group v7.2.4 -> latest
      • name - Internet Service IPv6 group name. Source firewall.internet-service-group.name. type: str required: true more...
        Supported Version Ranges
        name v7.2.4 -> latest
    • internet_service6_name - Internet Service IPv6 name. type: list member_path: internet_service6_name:name more...
      Supported Version Ranges
      internet_service6_name v7.2.4 -> latest
      • name - Internet Service IPv6 name. Source firewall.internet-service-name.name. type: str required: true more...
        Supported Version Ranges
        name v7.2.4 -> latest
    • internet_service6_negate - When enabled, Internet Services match against any internet service IPv6 EXCEPT the selected Internet Service IPv6. type: str choices: enable, disable more...
      Supported Version Ranges
      internet_service6_negate v7.2.4 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • ips_sensor - Name of an existing IPS sensor. Source ips.sensor.name. type: str more...
      Supported Version Ranges
      ips_sensor v6.0.0 -> latest
    • ips_voip_filter - Name of an existing VoIP (ips) profile. Source voip.profile.name. type: str more...
      Supported Version Ranges
      ips_voip_filter v7.4.0 -> latest
    • label - VDOM-specific GUI visible label. type: str more...
      Supported Version Ranges
      label v6.0.0 -> v6.0.11 v6.2.3 -> v6.2.3
    • logtraffic - Enable/disable logging traffic through the policy. type: str choices: all, utm, disable more...
      Supported Version Ranges
      logtraffic v6.0.0 -> latest
      [all] v6.0.0 -> latest
      [utm] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • logtraffic_start - Enable/disable policy log traffic start. type: str choices: enable, disable more...
      Supported Version Ranges
      logtraffic_start v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • 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.4.0 -> v6.4.0 v6.4.4 -> latest
    • policyid - Policy ID. see Notes. type: int required: true more...
      Supported Version Ranges
      policyid v6.0.0 -> latest
    • poolname - Name of IP pool object. type: list member_path: poolname:name more...
      Supported Version Ranges
      poolname v6.0.0 -> latest
      • name - IP pool name. Source firewall.ippool.name. type: str required: true more...
        Supported Version Ranges
        name v6.0.0 -> latest
    • profile_group - Name of profile group. Source firewall.profile-group.name. type: str more...
      Supported Version Ranges
      profile_group v6.0.0 -> latest
    • 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 -> latest
    • 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 -> latest
      [single] v6.0.0 -> latest
      [group] v6.0.0 -> latest
    • proxy - Type of explicit proxy. type: str choices: explicit-web, transparent-web, ftp, ssh, ssh-tunnel, access-proxy, wanopt more...
      Supported Version Ranges
      proxy v6.0.0 -> latest
      [explicit-web] v6.0.0 -> latest
      [transparent-web] v6.0.0 -> latest
      [ftp] v6.0.0 -> latest
      [ssh] v6.0.0 -> latest
      [ssh-tunnel] v6.0.0 -> latest
      [access-proxy] v7.0.0 -> latest
      [wanopt] v6.0.0 -> latest
    • redirect_url - Redirect URL for further explicit web proxy processing. type: str more...
      Supported Version Ranges
      redirect_url v6.0.0 -> latest
    • replacemsg_override_group - Authentication replacement message override group. Source system.replacemsg-group.name. type: str more...
      Supported Version Ranges
      replacemsg_override_group v6.0.0 -> latest
    • scan_botnet_connections - Enable/disable scanning of connections to Botnet servers. type: str choices: disable, block, monitor more...
      Supported Version Ranges
      scan_botnet_connections v6.0.0 -> v6.0.11
      [disable] v6.0.0 -> latest
      [block] v6.0.0 -> latest
      [monitor] v6.0.0 -> latest
    • schedule - Name of schedule object. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name. type: str more...
      Supported Version Ranges
      schedule v6.0.0 -> latest
    • sctp_filter_profile - Name of an existing SCTP filter profile. Source sctp-filter.profile.name. type: str more...
      Supported Version Ranges
      sctp_filter_profile v7.0.1 -> latest
    • service - Name of service objects. type: list member_path: service:name more...
      Supported Version Ranges
      service v6.0.0 -> latest
      • name - Service name. Source firewall.service.custom.name firewall.service.group.name. type: str required: true more...
        Supported Version Ranges
        name v6.0.0 -> latest
    • service_negate - When enabled, services match against any service EXCEPT the specified destination services. type: str choices: enable, disable more...
      Supported Version Ranges
      service_negate v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • session_ttl - TTL in seconds for sessions accepted by this policy (0 means use the system ). type: int more...
      Supported Version Ranges
      session_ttl v6.0.0 -> latest
    • 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 objects. type: list member_path: srcaddr:name more...
      Supported Version Ranges
      srcaddr v6.0.0 -> latest
      • name - Address name. Source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name system .external-resource.name. type: str required: true more...
        Supported Version Ranges
        name v6.0.0 -> latest
    • srcaddr_negate - When enabled, source addresses match against any address EXCEPT the specified source addresses. type: str choices: enable, disable more...
      Supported Version Ranges
      srcaddr_negate v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • srcaddr6 - IPv6 source address objects. type: list member_path: srcaddr6:name more...
      Supported Version Ranges
      srcaddr6 v6.0.0 -> latest
      • 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 -> latest
    • srcintf - Source interface names. type: list member_path: srcintf:name more...
      Supported Version Ranges
      srcintf v6.0.0 -> latest
      • name - Interface name. Source system.interface.name system.zone.name system.sdwan.zone.name. type: str required: true more...
        Supported Version Ranges
        name v6.0.0 -> latest
    • 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 -> latest
    • 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 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • 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 -> latest
    • status - Enable/disable the active status of the policy. type: str choices: enable, disable more...
      Supported Version Ranges
      status v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • transparent - Enable to use the IP address of the client to connect to the server. type: str choices: enable, disable more...
      Supported Version Ranges
      transparent v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • users - Names of user objects. type: list member_path: users:name more...
      Supported Version Ranges
      users v6.0.0 -> latest
      • name - Group name. Source user.local.name user.certificate.name. type: str required: true more...
        Supported Version Ranges
        name v6.0.0 -> latest
    • utm_status - Enable the use of UTM profiles/sensors/lists. type: str choices: enable, disable more...
      Supported Version Ranges
      utm_status v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...
      Supported Version Ranges
      uuid v6.0.0 -> latest
    • videofilter_profile - Name of an existing VideoFilter profile. Source videofilter.profile.name. type: str more...
      Supported Version Ranges
      videofilter_profile v7.0.0 -> latest
    • virtual_patch_profile - Name of an existing virtual-patch profile. Source virtual-patch.profile.name. type: str more...
      Supported Version Ranges
      virtual_patch_profile v7.4.1 -> latest
    • voip_profile - Name of an existing VoIP profile. Source voip.profile.name. type: str more...
      Supported Version Ranges
      voip_profile v7.0.0 -> v7.2.4
    • waf_profile - Name of an existing Web application firewall profile. Source waf.profile.name. type: str more...
      Supported Version Ranges
      waf_profile v6.0.0 -> latest
    • webcache - Enable/disable web caching. type: str choices: enable, disable more...
      Supported Version Ranges
      webcache v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • webcache_https - Enable/disable web caching for HTTPS (Requires deep-inspection enabled in ssl-ssh-profile). type: str choices: disable, enable more...
      Supported Version Ranges
      webcache_https v6.0.0 -> latest
      [disable] v6.0.0 -> latest
      [enable] v6.0.0 -> latest
    • webfilter_profile - Name of an existing Web filter profile. Source webfilter.profile.name. type: str more...
      Supported Version Ranges
      webfilter_profile v6.0.0 -> latest
    • 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.0.0 -> latest
    • webproxy_profile - Name of web proxy profile. Source web-proxy.profile.name. type: str more...
      Supported Version Ranges
      webproxy_profile v6.0.0 -> latest
    • ztna_ems_tag - ZTNA EMS Tag names. type: list member_path: ztna_ems_tag:name more...
      Supported Version Ranges
      ztna_ems_tag v7.0.0 -> latest
      • name - EMS Tag name. Source firewall.address.name firewall.addrgrp.name. type: str required: true more...
        Supported Version Ranges
        name v7.0.0 -> latest
    • ztna_tags_match_logic - ZTNA tag matching logic. type: str choices: or, and more...
      Supported Version Ranges
      ztna_tags_match_logic v7.0.2 -> latest
      [or] v6.0.0 -> latest
      [and] v6.0.0 -> latest

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

Examples

- name: Configure proxy policies.
  fortinet.fortios.fortios_firewall_proxy_policy:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_proxy_policy:
          access_proxy:
              -
                  name: "default_name_4 (source firewall.access-proxy.name)"
          access_proxy6:
              -
                  name: "default_name_6 (source firewall.access-proxy6.name)"
          action: "accept"
          application_list: "<your_own_value> (source application.list.name)"
          av_profile: "<your_own_value> (source antivirus.profile.name)"
          block_notification: "enable"
          casb_profile: "<your_own_value> (source casb.profile.name)"
          cifs_profile: "<your_own_value> (source cifs.profile.name)"
          comments: "<your_own_value>"
          decrypted_traffic_mirror: "<your_own_value> (source firewall.decrypted-traffic-mirror.name)"
          detect_https_in_http_request: "enable"
          device_ownership: "enable"
          disclaimer: "disable"
          dlp_profile: "<your_own_value> (source dlp.profile.name)"
          dlp_sensor: "<your_own_value> (source dlp.sensor.name)"
          dstaddr:
              -
                  name: "default_name_21 (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name firewall
                    .vip.name firewall.vipgrp.name system.external-resource.name)"
          dstaddr_negate: "enable"
          dstaddr6:
              -
                  name: "default_name_24 (source firewall.address6.name firewall.addrgrp6.name firewall.vip6.name firewall.vipgrp6.name system
                    .external-resource.name)"
          dstintf:
              -
                  name: "default_name_26 (source system.interface.name system.zone.name system.sdwan.zone.name)"
          emailfilter_profile: "<your_own_value> (source emailfilter.profile.name)"
          file_filter_profile: "<your_own_value> (source file-filter.profile.name)"
          global_label: "<your_own_value>"
          groups:
              -
                  name: "default_name_31 (source user.group.name)"
          http_tunnel_auth: "enable"
          icap_profile: "<your_own_value> (source icap.profile.name)"
          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_name:
              -
                  name: "default_name_44 (source firewall.internet-service-name.name)"
          internet_service_negate: "enable"
          internet_service6: "enable"
          internet_service6_custom:
              -
                  name: "default_name_48 (source firewall.internet-service-custom.name)"
          internet_service6_custom_group:
              -
                  name: "default_name_50 (source firewall.internet-service-custom-group.name)"
          internet_service6_group:
              -
                  name: "default_name_52 (source firewall.internet-service-group.name)"
          internet_service6_name:
              -
                  name: "default_name_54 (source firewall.internet-service-name.name)"
          internet_service6_negate: "enable"
          ips_sensor: "<your_own_value> (source ips.sensor.name)"
          ips_voip_filter: "<your_own_value> (source voip.profile.name)"
          label: "<your_own_value>"
          logtraffic: "all"
          logtraffic_start: "enable"
          mms_profile: "<your_own_value> (source firewall.mms-profile.name)"
          name: "default_name_62"
          policyid: "<you_own_value>"
          poolname:
              -
                  name: "default_name_65 (source firewall.ippool.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"
          proxy: "explicit-web"
          redirect_url: "<your_own_value>"
          replacemsg_override_group: "<your_own_value> (source system.replacemsg-group.name)"
          scan_botnet_connections: "disable"
          schedule: "<your_own_value> (source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name)"
          sctp_filter_profile: "<your_own_value> (source sctp-filter.profile.name)"
          service:
              -
                  name: "default_name_76 (source firewall.service.custom.name firewall.service.group.name)"
          service_negate: "enable"
          session_ttl: "0"
          spamfilter_profile: "<your_own_value> (source spamfilter.profile.name)"
          srcaddr:
              -
                  name: "default_name_81 (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name system
                    .external-resource.name)"
          srcaddr_negate: "enable"
          srcaddr6:
              -
                  name: "default_name_84 (source firewall.address6.name firewall.addrgrp6.name system.external-resource.name)"
          srcintf:
              -
                  name: "default_name_86 (source system.interface.name system.zone.name system.sdwan.zone.name)"
          ssh_filter_profile: "<your_own_value> (source ssh-filter.profile.name)"
          ssh_policy_redirect: "enable"
          ssl_ssh_profile: "<your_own_value> (source firewall.ssl-ssh-profile.name)"
          status: "enable"
          transparent: "enable"
          users:
              -
                  name: "default_name_93 (source user.local.name user.certificate.name)"
          utm_status: "enable"
          uuid: "<your_own_value>"
          videofilter_profile: "<your_own_value> (source videofilter.profile.name)"
          virtual_patch_profile: "<your_own_value> (source virtual-patch.profile.name)"
          voip_profile: "<your_own_value> (source voip.profile.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)"
          ztna_ems_tag:
              -
                  name: "default_name_106 (source firewall.address.name firewall.addrgrp.name)"
          ztna_tags_match_logic: "or"

Return Values

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

  • 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.