:source: fmgd_ztna_trafficforwardproxy.py
:orphan:
.. _fmgd_ztna_trafficforwardproxy:
fmgd_ztna_trafficforwardproxy -- Configure ZTNA traffic forward proxy.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 1.0.0
.. 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.0 -> latest
Parameters
----------
.. raw:: html
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- device - The parameter in requested url type: str required: true
- vdom - The parameter in requested url type: str required: true
- ztna_trafficforwardproxy - Configure ZTNA traffic forward proxy. type: dict
- auth_portal (Alias name: auth-portal) Enable/disable authentication portal. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.0 -> latest
- client_cert (Alias name: client-cert) Enable/disable to request client certificate. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.0 -> latest
- comment Comment. type: str
more...
Supported Version Ranges: v7.6.0 -> latest
- empty_cert_action (Alias name: empty-cert-action) Action of an empty client certificate. type: str choices: [accept, block, accept-unmanageable]
more...
Supported Version Ranges: v7.6.0 -> latest
- h3_support (Alias name: h3-support) Enable/disable http3/quic support (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.0 -> latest
- interface Interface name type: list
more...
Supported Version Ranges: v7.6.0 -> latest
- log_blocked_traffic (Alias name: log-blocked-traffic) Enable/disable logging of blocked traffic. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.0 -> latest
- name Traffic forward proxy name type: str
more...
Supported Version Ranges: v7.6.0 -> latest
- port Accept incoming traffic on one or more ports (0 - 65535). type: str
more...
Supported Version Ranges: v7.6.0 -> latest
- quic Quic. type: dict
more...
Supported Version Ranges: v7.6.0 -> latest
- ack_delay_exponent (Alias name: ack-delay-exponent) Ack delay exponent (1 - 20, default = 3). type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- active_connection_id_limit (Alias name: active-connection-id-limit) Active connection id limit (1 - 8, default = 2). type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- active_migration (Alias name: active-migration) Enable/disable active migration (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.0 -> latest
- grease_quic_bit (Alias name: grease-quic-bit) Enable/disable grease quic bit (default = enable). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.0 -> latest
- max_ack_delay (Alias name: max-ack-delay) Maximum ack delay in milliseconds (1 - 16383, default = 25). type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- max_datagram_frame_size (Alias name: max-datagram-frame-size) Maximum datagram frame size in bytes (1 - 1500, default = 1500). type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- max_idle_timeout (Alias name: max-idle-timeout) Maximum idle timeout milliseconds (1 - 60000, default = 30000). type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- max_udp_payload_size (Alias name: max-udp-payload-size) Maximum udp payload size in bytes (1200 - 1500, default = 1500). type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_accept_ffdhe_groups (Alias name: ssl-accept-ffdhe-groups) Enable/disable ffdhe cipher suite for ssl key exchange. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_algorithm (Alias name: ssl-algorithm) Permitted encryption algorithms for ssl sessions according to encryption strength. type: str choices: [high, low, medium, custom]
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_certificate (Alias name: ssl-certificate) Name of the certificate to use for ssl handshake. type: list
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_cipher_suites (Alias name: ssl-cipher-suites) Ssl cipher suites. type: list
more...
Supported Version Ranges: v7.6.0 -> latest
- cipher Cipher suite name. type: str choices: [TLS-RSA-WITH-RC4-128-MD5, TLS-RSA-WITH-RC4-128-SHA, TLS-RSA-WITH-DES-CBC-SHA, TLS-RSA-WITH-3DES-EDE-CBC-SHA, TLS-RSA-WITH-AES-128-CBC-SHA, TLS-RSA-WITH-AES-256-CBC-SHA, TLS-RSA-WITH-AES-128-CBC-SHA256, TLS-RSA-WITH-AES-256-CBC-SHA256, TLS-RSA-WITH-CAMELLIA-128-CBC-SHA, TLS-RSA-WITH-CAMELLIA-256-CBC-SHA, TLS-RSA-WITH-CAMELLIA-128-CBC-SHA256, TLS-RSA-WITH-CAMELLIA-256-CBC-SHA256, TLS-RSA-WITH-SEED-CBC-SHA, TLS-RSA-WITH-ARIA-128-CBC-SHA256, TLS-RSA-WITH-ARIA-256-CBC-SHA384, TLS-DHE-RSA-WITH-DES-CBC-SHA, TLS-DHE-RSA-WITH-3DES-EDE-CBC-SHA, TLS-DHE-RSA-WITH-AES-128-CBC-SHA, TLS-DHE-RSA-WITH-AES-256-CBC-SHA, TLS-DHE-RSA-WITH-AES-128-CBC-SHA256, TLS-DHE-RSA-WITH-AES-256-CBC-SHA256, TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA, TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA, TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA256, TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA256, TLS-DHE-RSA-WITH-SEED-CBC-SHA, TLS-DHE-RSA-WITH-ARIA-128-CBC-SHA256, TLS-DHE-RSA-WITH-ARIA-256-CBC-SHA384, TLS-ECDHE-RSA-WITH-RC4-128-SHA, TLS-ECDHE-RSA-WITH-3DES-EDE-CBC-SHA, TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA, TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA, TLS-ECDHE-RSA-WITH-CHACHA20-POLY1305-SHA256, TLS-ECDHE-ECDSA-WITH-CHACHA20-POLY1305-SHA256, TLS-DHE-RSA-WITH-CHACHA20-POLY1305-SHA256, TLS-DHE-RSA-WITH-AES-128-GCM-SHA256, TLS-DHE-RSA-WITH-AES-256-GCM-SHA384, TLS-DHE-DSS-WITH-AES-128-CBC-SHA, TLS-DHE-DSS-WITH-AES-256-CBC-SHA, TLS-DHE-DSS-WITH-AES-128-CBC-SHA256, TLS-DHE-DSS-WITH-AES-128-GCM-SHA256, TLS-DHE-DSS-WITH-AES-256-CBC-SHA256, TLS-DHE-DSS-WITH-AES-256-GCM-SHA384, TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA256, TLS-ECDHE-RSA-WITH-AES-128-GCM-SHA256, TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA384, TLS-ECDHE-RSA-WITH-AES-256-GCM-SHA384, TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA, TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA256, TLS-ECDHE-ECDSA-WITH-AES-128-GCM-SHA256, TLS-ECDHE-ECDSA-WITH-AES-256-CBC-SHA384, TLS-ECDHE-ECDSA-WITH-AES-256-GCM-SHA384, TLS-RSA-WITH-AES-128-GCM-SHA256, TLS-RSA-WITH-AES-256-GCM-SHA384, TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA, TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA, TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA256, TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA256, TLS-DHE-DSS-WITH-SEED-CBC-SHA, TLS-DHE-DSS-WITH-ARIA-128-CBC-SHA256, TLS-DHE-DSS-WITH-ARIA-256-CBC-SHA384, TLS-ECDHE-RSA-WITH-ARIA-128-CBC-SHA256, TLS-ECDHE-RSA-WITH-ARIA-256-CBC-SHA384, TLS-ECDHE-ECDSA-WITH-ARIA-128-CBC-SHA256, TLS-ECDHE-ECDSA-WITH-ARIA-256-CBC-SHA384, TLS-DHE-DSS-WITH-3DES-EDE-CBC-SHA, TLS-DHE-DSS-WITH-DES-CBC-SHA, TLS-AES-128-GCM-SHA256, TLS-AES-256-GCM-SHA384, TLS-CHACHA20-POLY1305-SHA256, TLS-ECDHE-ECDSA-WITH-AES-256-CBC-SHA]
more...
Supported Version Ranges: v7.6.0 -> latest
- priority Ssl/tls cipher suites priority. type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- versions Ssl/tls versions that the cipher suite can be used with. type: list choices: [ssl-3.0, tls-1.0, tls-1.1, tls-1.2, tls-1.3]
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_client_fallback (Alias name: ssl-client-fallback) Enable/disable support for preventing downgrade attacks on client connections (rfc 7507). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_client_rekey_count (Alias name: ssl-client-rekey-count) Maximum length of data in mb before triggering a client rekey (0 = disable). type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_client_renegotiation (Alias name: ssl-client-renegotiation) Allow, deny, or require secure renegotiation of client sessions to comply with rfc 5746. type: str choices: [allow, deny, secure]
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_client_session_state_max (Alias name: ssl-client-session-state-max) Maximum number of client to fortiproxy ssl session states to keep. type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_client_session_state_timeout (Alias name: ssl-client-session-state-timeout) Number of minutes to keep client to fortiproxy ssl session state. type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_client_session_state_type (Alias name: ssl-client-session-state-type) How to expire ssl sessions for the segment of the ssl connection between the client and the fortigate. type: str choices: [disable, time, count, both]
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_dh_bits (Alias name: ssl-dh-bits) Bit-size of diffie-hellman (dh) prime used in dhe-rsa negotiation (default = 2048). type: str choices: [768, 1024, 1536, 2048, 3072, 4096]
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_hpkp (Alias name: ssl-hpkp) Enable/disable including hpkp header in response. type: str choices: [disable, enable, report-only]
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_hpkp_age (Alias name: ssl-hpkp-age) Number of seconds the client should honor the hpkp setting. type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_hpkp_backup (Alias name: ssl-hpkp-backup) Certificate to generate backup hpkp pin from. type: list
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_hpkp_include_subdomains (Alias name: ssl-hpkp-include-subdomains) Indicate that hpkp header applies to all subdomains. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_hpkp_primary (Alias name: ssl-hpkp-primary) Certificate to generate primary hpkp pin from. type: list
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_hpkp_report_uri (Alias name: ssl-hpkp-report-uri) Url to report hpkp violations to. type: str
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_hsts (Alias name: ssl-hsts) Enable/disable including hsts header in response. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_hsts_age (Alias name: ssl-hsts-age) Number of seconds the client should honor the hsts setting. type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_hsts_include_subdomains (Alias name: ssl-hsts-include-subdomains) Indicate that hsts header applies to all subdomains. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_http_location_conversion (Alias name: ssl-http-location-conversion) Enable to replace http with https in the replys location http header field. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_http_match_host (Alias name: ssl-http-match-host) Enable/disable http host matching for location conversion. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_max_version (Alias name: ssl-max-version) Highest ssl/tls version acceptable from a client. type: str choices: [ssl-3.0, tls-1.0, tls-1.1, tls-1.2, tls-1.3]
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_min_version (Alias name: ssl-min-version) Lowest ssl/tls version acceptable from a client. type: str choices: [ssl-3.0, tls-1.0, tls-1.1, tls-1.2, tls-1.3]
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_mode (Alias name: ssl-mode) Apply ssl offloading between the client and the fortigate (half) or from the client to the fortigate and from the fortigate to the server (full). type: str choices: [half, full]
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_pfs (Alias name: ssl-pfs) Select the cipher suites that can be used for ssl perfect forward secrecy (pfs). type: str choices: [require, deny, allow]
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_send_empty_frags (Alias name: ssl-send-empty-frags) Enable/disable sending empty fragments to avoid cbc iv attacks (ssl 3. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_server_algorithm (Alias name: ssl-server-algorithm) Permitted encryption algorithms for the server side of ssl full mode sessions according to encryption strength. type: str choices: [high, low, medium, custom, client]
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_server_cipher_suites (Alias name: ssl-server-cipher-suites) Ssl server cipher suites. type: list
more...
Supported Version Ranges: v7.6.0 -> latest
- cipher Cipher suite name. type: str choices: [TLS-RSA-WITH-RC4-128-MD5, TLS-RSA-WITH-RC4-128-SHA, TLS-RSA-WITH-DES-CBC-SHA, TLS-RSA-WITH-3DES-EDE-CBC-SHA, TLS-RSA-WITH-AES-128-CBC-SHA, TLS-RSA-WITH-AES-256-CBC-SHA, TLS-RSA-WITH-AES-128-CBC-SHA256, TLS-RSA-WITH-AES-256-CBC-SHA256, TLS-RSA-WITH-CAMELLIA-128-CBC-SHA, TLS-RSA-WITH-CAMELLIA-256-CBC-SHA, TLS-RSA-WITH-CAMELLIA-128-CBC-SHA256, TLS-RSA-WITH-CAMELLIA-256-CBC-SHA256, TLS-RSA-WITH-SEED-CBC-SHA, TLS-RSA-WITH-ARIA-128-CBC-SHA256, TLS-RSA-WITH-ARIA-256-CBC-SHA384, TLS-DHE-RSA-WITH-DES-CBC-SHA, TLS-DHE-RSA-WITH-3DES-EDE-CBC-SHA, TLS-DHE-RSA-WITH-AES-128-CBC-SHA, TLS-DHE-RSA-WITH-AES-256-CBC-SHA, TLS-DHE-RSA-WITH-AES-128-CBC-SHA256, TLS-DHE-RSA-WITH-AES-256-CBC-SHA256, TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA, TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA, TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA256, TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA256, TLS-DHE-RSA-WITH-SEED-CBC-SHA, TLS-DHE-RSA-WITH-ARIA-128-CBC-SHA256, TLS-DHE-RSA-WITH-ARIA-256-CBC-SHA384, TLS-ECDHE-RSA-WITH-RC4-128-SHA, TLS-ECDHE-RSA-WITH-3DES-EDE-CBC-SHA, TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA, TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA, TLS-ECDHE-RSA-WITH-CHACHA20-POLY1305-SHA256, TLS-ECDHE-ECDSA-WITH-CHACHA20-POLY1305-SHA256, TLS-DHE-RSA-WITH-CHACHA20-POLY1305-SHA256, TLS-DHE-RSA-WITH-AES-128-GCM-SHA256, TLS-DHE-RSA-WITH-AES-256-GCM-SHA384, TLS-DHE-DSS-WITH-AES-128-CBC-SHA, TLS-DHE-DSS-WITH-AES-256-CBC-SHA, TLS-DHE-DSS-WITH-AES-128-CBC-SHA256, TLS-DHE-DSS-WITH-AES-128-GCM-SHA256, TLS-DHE-DSS-WITH-AES-256-CBC-SHA256, TLS-DHE-DSS-WITH-AES-256-GCM-SHA384, TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA256, TLS-ECDHE-RSA-WITH-AES-128-GCM-SHA256, TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA384, TLS-ECDHE-RSA-WITH-AES-256-GCM-SHA384, TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA, TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA256, TLS-ECDHE-ECDSA-WITH-AES-128-GCM-SHA256, TLS-ECDHE-ECDSA-WITH-AES-256-CBC-SHA384, TLS-ECDHE-ECDSA-WITH-AES-256-GCM-SHA384, TLS-RSA-WITH-AES-128-GCM-SHA256, TLS-RSA-WITH-AES-256-GCM-SHA384, TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA, TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA, TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA256, TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA256, TLS-DHE-DSS-WITH-SEED-CBC-SHA, TLS-DHE-DSS-WITH-ARIA-128-CBC-SHA256, TLS-DHE-DSS-WITH-ARIA-256-CBC-SHA384, TLS-ECDHE-RSA-WITH-ARIA-128-CBC-SHA256, TLS-ECDHE-RSA-WITH-ARIA-256-CBC-SHA384, TLS-ECDHE-ECDSA-WITH-ARIA-128-CBC-SHA256, TLS-ECDHE-ECDSA-WITH-ARIA-256-CBC-SHA384, TLS-DHE-DSS-WITH-3DES-EDE-CBC-SHA, TLS-DHE-DSS-WITH-DES-CBC-SHA, TLS-AES-128-GCM-SHA256, TLS-AES-256-GCM-SHA384, TLS-CHACHA20-POLY1305-SHA256, TLS-ECDHE-ECDSA-WITH-AES-256-CBC-SHA]
more...
Supported Version Ranges: v7.6.0 -> latest
- priority Ssl/tls cipher suites priority. type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- versions Ssl/tls versions that the cipher suite can be used with. type: list choices: [ssl-3.0, tls-1.0, tls-1.1, tls-1.2, tls-1.3]
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_server_max_version (Alias name: ssl-server-max-version) Highest ssl/tls version acceptable from a server. type: str choices: [ssl-3.0, tls-1.0, tls-1.1, tls-1.2, client, tls-1.3]
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_server_min_version (Alias name: ssl-server-min-version) Lowest ssl/tls version acceptable from a server. type: str choices: [ssl-3.0, tls-1.0, tls-1.1, tls-1.2, client, tls-1.3]
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_server_renegotiation (Alias name: ssl-server-renegotiation) Enable/disable secure renegotiation to comply with rfc 5746. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_server_session_state_max (Alias name: ssl-server-session-state-max) Maximum number of fortigate to server ssl session states to keep. type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_server_session_state_timeout (Alias name: ssl-server-session-state-timeout) Number of minutes to keep fortigate to server ssl session state. type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- ssl_server_session_state_type (Alias name: ssl-server-session-state-type) How to expire ssl sessions for the segment of the ssl connection between the server and the fortigate. type: str choices: [disable, time, count, both]
more...
Supported Version Ranges: v7.6.0 -> latest
- status Enable/disable the traffic forward proxy for ztna traffic. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.0 -> latest
- svr_pool_multiplex (Alias name: svr-pool-multiplex) Enable/disable server pool multiplexing. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.0 -> latest
- svr_pool_server_max_concurrent_request (Alias name: svr-pool-server-max-concurrent-request) Maximum number of concurrent requests that servers in server pool could handle (default = unlimited). type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- svr_pool_server_max_request (Alias name: svr-pool-server-max-request) Maximum number of requests that servers in server pool handle before disconnecting (default = unlimited). type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- svr_pool_ttl (Alias name: svr-pool-ttl) Time-to-live in the server pool for idle connections to servers. type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- user_agent_detect (Alias name: user-agent-detect) Enable/disable to detect device type by http user-agent if no client certificate provided. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.0 -> latest
- auth_virtual_host (Alias name: auth-virtual-host) Virtual host for authentication portal. type: list
more...
Supported Version Ranges: v7.6.2 -> latest
- decrypted_traffic_mirror (Alias name: decrypted-traffic-mirror) Decrypted traffic mirror. type: list
more...
Supported Version Ranges: v7.6.2 -> latest
- host Virtual or real host name. type: list
more...
Supported Version Ranges: v7.6.2 -> latest
- vip Virtual ip name. type: list
more...
Supported Version Ranges: v7.6.2 -> latest
- vip6 Virtual ipv6 name. type: list
more...
Supported Version Ranges: v7.6.2 -> latest
- url_route (Alias name: url-route) Url route. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
- name Name. type: str
more...
Supported Version Ranges: v7.6.4 -> latest
- service_connector (Alias name: service-connector) Service connector. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
- url_pattern (Alias name: url-pattern) Url pattern. type: str
more...
Supported Version Ranges: v7.6.4 -> latest
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
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure ZTNA traffic forward proxy.
fortinet.fmgdevice.fmgd_ztna_trafficforwardproxy:
# bypass_validation: false
# workspace_locking_adom:
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device:
vdom:
state: present #
ztna_trafficforwardproxy:
name: "your value" # Required variable, string
# auth_portal:
# client_cert:
# comment:
# empty_cert_action:
# h3_support:
# interface:
# log_blocked_traffic:
# port:
# 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_accept_ffdhe_groups:
# ssl_algorithm:
# ssl_certificate:
# ssl_cipher_suites:
# - cipher:
# priority:
# versions:
# - "ssl-3.0"
# - "tls-1.0"
# - "tls-1.1"
# - "tls-1.2"
# - "tls-1.3"
# ssl_client_fallback:
# ssl_client_rekey_count:
# ssl_client_renegotiation:
# ssl_client_session_state_max:
# ssl_client_session_state_timeout:
# ssl_client_session_state_type:
# ssl_dh_bits:
# ssl_hpkp:
# ssl_hpkp_age:
# ssl_hpkp_backup:
# ssl_hpkp_include_subdomains:
# ssl_hpkp_primary:
# ssl_hpkp_report_uri:
# ssl_hsts:
# ssl_hsts_age:
# ssl_hsts_include_subdomains:
# ssl_http_location_conversion:
# ssl_http_match_host:
# ssl_max_version:
# ssl_min_version:
# ssl_mode:
# ssl_pfs:
# ssl_send_empty_frags:
# ssl_server_algorithm:
# ssl_server_cipher_suites:
# - cipher:
# priority:
# versions:
# - "ssl-3.0"
# - "tls-1.0"
# - "tls-1.1"
# - "tls-1.2"
# - "tls-1.3"
# ssl_server_max_version:
# ssl_server_min_version:
# ssl_server_renegotiation:
# ssl_server_session_state_max:
# ssl_server_session_state_timeout:
# ssl_server_session_state_type:
# status:
# svr_pool_multiplex:
# svr_pool_server_max_concurrent_request:
# svr_pool_server_max_request:
# svr_pool_ttl:
# user_agent_detect:
# auth_virtual_host:
# decrypted_traffic_mirror:
# host:
# vip:
# vip6:
# url_route:
# - name:
# service_connector:
# url_pattern:
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)