:source: fortios_firewall_proxy_policy.py :orphan: .. fortios_firewall_proxy_policy: fortios_firewall_proxy_policy -- Configure proxy policies in Fortinet's FortiOS and FortiGate. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. versionadded:: 2.0.0 .. contents:: :local: :depth: 1 Synopsis -------- - This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and 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.15 Tips ---- Using member operation to add an element to an existing object. FortiOS Version Compatibility ----------------------------- Supported Version Ranges: v6.0.0 -> v7.6.6 Parameters ---------- .. raw:: html Notes ----- .. note:: - We highly recommend using your own value as the policyid instead of 0, while '0' is a special placeholder that allows the backend to assign the latest available number for the object, it does have limitations. Please find more details in Q&A. - Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks - The module supports check_mode. Examples -------- .. code-block:: yaml+jinja - name: Configure proxy policies. fortinet.fortios.fortios_firewall_proxy_policy: vdom: "{{ vdom }}" state: "present" access_token: "" 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: " (source application.list.name)" av_profile: " (source antivirus.profile.name)" block_notification: "enable" casb_profile: " (source casb.profile.name)" cifs_profile: " (source cifs.profile.name)" comments: "" decrypted_traffic_mirror: " (source firewall.decrypted-traffic-mirror.name)" detect_https_in_http_request: "enable" device_ownership: "enable" diameter_filter_profile: " (source diameter-filter.profile.name)" disclaimer: "disable" dlp_profile: " (source dlp.profile.name)" dlp_sensor: " (source dlp.sensor.name)" dnsfilter_profile: " (source dnsfilter.profile.name)" dstaddr: - name: "default_name_23 (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_26 (source firewall.address6.name firewall.addrgrp6.name firewall.vip6.name firewall.vipgrp6.name system .external-resource.name)" dstintf: - name: "default_name_28 (source system.interface.name system.zone.name system.sdwan.zone.name)" emailfilter_profile: " (source emailfilter.profile.name)" file_filter_profile: " (source file-filter.profile.name)" global_label: "" groups: - name: "default_name_33 (source user.group.name)" http_tunnel_auth: "enable" https_sub_category: "enable" icap_profile: " (source icap.profile.name)" internet_service: "enable" internet_service_custom: - name: "default_name_39 (source firewall.internet-service-custom.name)" internet_service_custom_group: - name: "default_name_41 (source firewall.internet-service-custom-group.name)" internet_service_fortiguard: - name: "default_name_43 (source firewall.internet-service-fortiguard.name)" internet_service_group: - name: "default_name_45 (source firewall.internet-service-group.name)" internet_service_id: - id: "47 (source firewall.internet-service.id)" internet_service_name: - name: "default_name_49 (source firewall.internet-service-name.name)" internet_service_negate: "enable" internet_service6: "enable" internet_service6_custom: - name: "default_name_53 (source firewall.internet-service-custom.name)" internet_service6_custom_group: - name: "default_name_55 (source firewall.internet-service-custom-group.name)" internet_service6_fortiguard: - name: "default_name_57 (source firewall.internet-service-fortiguard.name)" internet_service6_group: - name: "default_name_59 (source firewall.internet-service-group.name)" internet_service6_name: - name: "default_name_61 (source firewall.internet-service-name.name)" internet_service6_negate: "enable" ips_sensor: " (source ips.sensor.name)" ips_voip_filter: " (source voip.profile.name)" isolator_server: " (source web-proxy.isolator-server.name)" label: "" log_http_transaction: "enable" logtraffic: "all" logtraffic_start: "enable" mms_profile: " (source firewall.mms-profile.name)" name: "default_name_71" policyid: "" poolname: - name: "default_name_74 (source firewall.ippool.name)" poolname6: - name: "default_name_76 (source firewall.ippool6.name)" profile_group: " (source firewall.profile-group.name)" profile_protocol_options: " (source firewall.profile-protocol-options.name)" profile_type: "single" proxy: "explicit-web" redirect_url: "" replacemsg_override_group: " (source system.replacemsg-group.name)" scan_botnet_connections: "disable" schedule: " (source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name)" sctp_filter_profile: " (source sctp-filter.profile.name)" service: - name: "default_name_87 (source firewall.service.custom.name firewall.service.group.name)" service_negate: "enable" session_ttl: "0" spamfilter_profile: " (source spamfilter.profile.name)" srcaddr: - name: "default_name_92 (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_95 (source firewall.address6.name firewall.addrgrp6.name system.external-resource.name)" srcintf: - name: "default_name_97 (source system.interface.name system.zone.name system.sdwan.zone.name)" ssh_filter_profile: " (source ssh-filter.profile.name)" ssh_policy_redirect: "enable" ssl_ssh_profile: " (source firewall.ssl-ssh-profile.name)" status: "enable" telemetry_profile: " (source telemetry-controller.profile.name)" transparent: "enable" url_risk: - name: "default_name_105 (source webfilter.ftgd-risk-level.name)" users: - name: "default_name_107 (source user.local.name user.certificate.name)" utm_status: "enable" uuid: "" videofilter_profile: " (source videofilter.profile.name)" virtual_patch_profile: " (source virtual-patch.profile.name)" voip_profile: " (source voip.profile.name)" waf_profile: " (source waf.profile.name)" webcache: "enable" webcache_https: "disable" webfilter_profile: " (source webfilter.profile.name)" webproxy_forward_server: " (source web-proxy.forward-server.name web-proxy.forward-server-group.name)" webproxy_profile: " (source web-proxy.profile.name)" ztna_ems_tag: - name: "default_name_120 (source firewall.address.name firewall.addrgrp.name)" ztna_ems_tag_negate: "enable" ztna_proxy: - name: "default_name_123 (source ztna.traffic-forward-proxy.name ztna.web-proxy.name ztna.web-portal.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: .. raw:: html
  • build - Build number of the fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status ------ - This module is not guaranteed to have a backwards compatible interface. Authors ------- - Link Zheng (@chillancezen) - Jie Xue (@JieX19) - Hongbin Lu (@fgtdev-hblu) - Frank Shen (@frankshen01) - Miguel Angel Munoz (@mamunozgonzalez) - Nicolas Thomas (@thomnico) .. hint:: If you notice any issues in this documentation, you can create a pull request to improve it.