:source: fmgr_ztna_trafficforwardproxy.py :orphan: .. _fmgr_ztna_trafficforwardproxy: fmgr_ztna_trafficforwardproxy -- Configure ZTNA traffic forward proxy. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. versionadded:: 2.12.0 .. warning:: Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case). - Argument name before 3.0.0: ``var-name``, ``var name``, ``var.name`` - New argument name starting in 3.0.0: ``var_name`` FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg. .. contents:: :local: :depth: 1 Synopsis -------- - This module is able to configure a FortiManager device. - Examples include all parameters and values need to be adjusted to data sources before usage. - Tested with FortiManager v7.x. Requirements ------------ The below requirements are needed on the host that executes this module. - ansible-core>=2.16.0 FortiManager Version Compatibility ---------------------------------- .. raw:: html

Supported Version Ranges: v7.6.4 -> latest

Parameters ---------- .. raw:: html Notes ----- .. note:: - Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work. - To create or update an object, use state: present directive. - To delete an object, use state: absent directive - Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded Examples -------- .. code-block:: yaml+jinja - name: Example playbook (generated based on argument schema) hosts: fortimanagers connection: httpapi gather_facts: false tasks: - name: Configure ZTNA traffic forward proxy. fortinet.fortimanager.fmgr_ztna_trafficforwardproxy: # workspace_locking_adom: adom: state: present # ztna_trafficforwardproxy: name: "your value" # Required variable, string # auth_portal: # auth_virtual_host: # decrypted_traffic_mirror: # host: # log_blocked_traffic: # url_route: # - name: # service_connector: # url_pattern: # vip: # ssl_client_session_state_max: # ssl_send_empty_frags: # ssl_server_max_version: # ssl_accept_ffdhe_groups: # empty_cert_action: # quic: # ack_delay_exponent: # active_connection_id_limit: # active_migration: # grease_quic_bit: # max_ack_delay: # max_datagram_frame_size: # max_idle_timeout: # max_udp_payload_size: # ssl_server_session_state_max: # ssl_client_session_state_type: # ssl_hpkp_age: # ssl_hpkp_report_uri: # ssl_min_version: # ssl_mode: # ssl_client_session_state_timeout: # ssl_hsts_age: # interface: # ssl_client_renegotiation: # ssl_server_session_state_timeout: # ssl_server_min_version: # ssl_cipher_suites: # - cipher: # priority: # versions: ["ssl-3.0", "tls-1.0", "tls-1.1", "tls-1.2", "tls-1.3"] # ssl_client_rekey_count: # svr_pool_server_max_request: # ssl_dh_bits: # port: # ssl_http_match_host: # ssl_server_session_state_type: # status: # svr_pool_multiplex: # ssl_hpkp: # ssl_hsts: # svr_pool_server_max_concurrent_request: # h3_support: # ssl_http_location_conversion: # comment: # ssl_pfs: # ssl_hsts_include_subdomains: # ssl_certificate: # ssl_max_version: # ssl_hpkp_backup: # client_cert: # ssl_client_fallback: # vip6: # ssl_algorithm: # ssl_server_algorithm: # ssl_hpkp_include_subdomains: # user_agent_detect: # ssl_server_renegotiation: # svr_pool_ttl: # ssl_server_cipher_suites: # - cipher: # priority: # versions: ["ssl-3.0", "tls-1.0", "tls-1.1", "tls-1.2", "tls-1.3"] # ssl_hpkp_primary: 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
  • meta - The result of the request.returned: always type: dict
    • request_url - The full url requested. returned: always type: str sample: /sys/login/user
    • response_code - The status of api request. returned: always type: int sample: 0
    • response_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status ------ - This module is not guaranteed to have a backwards compatible interface. Authors ------- - Xinwei Du (@dux-fortinet) - Xing Li (@lix-fortinet) - Jie Xue (@JieX19) - Link Zheng (@chillancezen) - Frank Shen (@fshen01) - Hongbin Lu (@fgtdev-hblu)