:source: fortios_ztna_web_proxy.py :orphan: .. fortios_ztna_web_proxy: fortios_ztna_web_proxy -- Configure ZTNA web-proxy 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 ztna feature and web_proxy 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.16 Tips ---- Using member operation to add an element to an existing object. FortiOS Version Compatibility ----------------------------- Supported Version Ranges: v7.6.1 -> v7.6.6 Parameters ---------- .. raw:: html Notes ----- .. note:: - Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks Examples -------- .. code-block:: yaml+jinja - name: Configure ZTNA web-proxy. fortinet.fortios.fortios_ztna_web_proxy: vdom: "{{ vdom }}" state: "present" access_token: "" ztna_web_proxy: api_gateway: - h2_support: "enable" h3_support: "enable" http_cookie_age: "60" http_cookie_domain: "" http_cookie_domain_from_host: "disable" http_cookie_generation: "0" http_cookie_path: "" http_cookie_share: "disable" https_cookie_secure: "disable" id: "13" ldb_method: "static" persistence: "none" quic: ack_delay_exponent: "3" active_connection_id_limit: "2" active_migration: "enable" grease_quic_bit: "enable" max_ack_delay: "25" max_datagram_frame_size: "1500" max_idle_timeout: "30000" max_udp_payload_size: "1500" realservers: - addr_type: "ip" address: " (source firewall.address.name firewall.addrgrp.name)" health_check: "disable" health_check_proto: "ping" holddown_interval: "enable" http_host: "myhostname" id: "32" ip: "" port: "443" status: "active" translate_host: "enable" verify_cert: "enable" weight: "1" service: "http" ssl_algorithm: "high" ssl_cipher_suites: - cipher: "TLS-AES-128-GCM-SHA256" priority: "" versions: "tls-1.0" ssl_dh_bits: "768" ssl_max_version: "tls-1.0" ssl_min_version: "tls-1.0" ssl_renegotiation: "enable" url_map: "" url_map_type: "sub-string" api_gateway6: - h2_support: "enable" h3_support: "enable" http_cookie_age: "60" http_cookie_domain: "" http_cookie_domain_from_host: "disable" http_cookie_generation: "0" http_cookie_path: "" http_cookie_share: "disable" https_cookie_secure: "disable" id: "61" ldb_method: "static" persistence: "none" quic: ack_delay_exponent: "3" active_connection_id_limit: "2" active_migration: "enable" grease_quic_bit: "enable" max_ack_delay: "25" max_datagram_frame_size: "1500" max_idle_timeout: "30000" max_udp_payload_size: "1500" realservers: - addr_type: "ip" address: " (source firewall.address6.name firewall.addrgrp6.name)" health_check: "disable" health_check_proto: "ping" holddown_interval: "enable" http_host: "myhostname" id: "80" ip: "" port: "443" status: "active" translate_host: "enable" verify_cert: "enable" weight: "1" service: "http" ssl_algorithm: "high" ssl_cipher_suites: - cipher: "TLS-AES-128-GCM-SHA256" priority: "" versions: "tls-1.0" ssl_dh_bits: "768" ssl_max_version: "tls-1.0" ssl_min_version: "tls-1.0" ssl_renegotiation: "enable" url_map: "" url_map_type: "sub-string" auth_portal: "disable" auth_virtual_host: "myhostname (source firewall.access-proxy-virtual-host.name)" decrypted_traffic_mirror: " (source firewall.decrypted-traffic-mirror.name)" host: "myhostname (source firewall.access-proxy-virtual-host.name)" log_blocked_traffic: "disable" name: "default_name_104" svr_pool_multiplex: "enable" svr_pool_server_max_concurrent_request: "0" svr_pool_server_max_request: "0" svr_pool_ttl: "15" vip: " (source firewall.vip.name)" vip6: " (source firewall.vip6.name)" Return Values ------------- Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module: .. raw:: html
  • build - Build number of the fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status ------ - This module is not guaranteed to have a backwards compatible interface. Authors ------- - Link Zheng (@chillancezen) - Jie Xue (@JieX19) - Hongbin Lu (@fgtdev-hblu) - Frank Shen (@frankshen01) - Miguel Angel Munoz (@mamunozgonzalez) - Nicolas Thomas (@thomnico) .. hint:: If you notice any issues in this documentation, you can create a pull request to improve it.