fortinet.fortimanager.fmgr_ztna_trafficforwardproxy module – Configure ZTNA traffic forward proxy.

Note

This module is part of the fortinet.fortimanager collection (version 2.12.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_ztna_trafficforwardproxy.

New in fortinet.fortimanager 2.12.0

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter

Comments

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

revision_note

string

The change note that can be specified when an object is created or updated.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

workspace_locking_adom

string

The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

ztna_trafficforwardproxy

dictionary

The top level parameters set.

auth_portal

aliases: auth-portal

string

Enable/disable authentication portal.

Choices:

  • "disable"

  • "enable"

auth_virtual_host

aliases: auth-virtual-host

list / elements=string

Virtual host for authentication portal.

client_cert

aliases: client-cert

string

Client cert.

Choices:

  • "disable"

  • "enable"

comment

string

Comment.

decrypted_traffic_mirror

aliases: decrypted-traffic-mirror

list / elements=string

Decrypted traffic mirror.

empty_cert_action

aliases: empty-cert-action

string

Empty cert action.

Choices:

  • "accept"

  • "block"

  • "accept-unmanageable"

h3_support

aliases: h3-support

string

H3 support.

Choices:

  • "disable"

  • "enable"

host

list / elements=string

Virtual or real host name.

interface

list / elements=string

Interface.

log_blocked_traffic

aliases: log-blocked-traffic

string

Enable/disable logging of blocked traffic.

Choices:

  • "disable"

  • "enable"

name

string / required

ZTNA proxy name.

port

string

Port.

quic

dictionary

Quic.

ack_delay_exponent

aliases: ack-delay-exponent

integer

Ack delay exponent.

active_connection_id_limit

aliases: active-connection-id-limit

integer

Active connection id limit.

active_migration

aliases: active-migration

string

Active migration.

Choices:

  • "disable"

  • "enable"

grease_quic_bit

aliases: grease-quic-bit

string

Grease quic bit.

Choices:

  • "disable"

  • "enable"

max_ack_delay

aliases: max-ack-delay

integer

Max ack delay.

max_datagram_frame_size

aliases: max-datagram-frame-size

integer

Max datagram frame size.

max_idle_timeout

aliases: max-idle-timeout

integer

Max idle timeout.

max_udp_payload_size

aliases: max-udp-payload-size

integer

Max udp payload size.

ssl_accept_ffdhe_groups

aliases: ssl-accept-ffdhe-groups

string

Ssl accept ffdhe groups.

Choices:

  • "disable"

  • "enable"

ssl_algorithm

aliases: ssl-algorithm

string

Ssl algorithm.

Choices:

  • "high"

  • "low"

  • "medium"

  • "custom"

ssl_certificate

aliases: ssl-certificate

list / elements=string

Ssl certificate.

ssl_cipher_suites

aliases: ssl-cipher-suites

list / elements=dictionary

Ssl cipher suites.

cipher

string

Cipher.

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"

priority

integer

Priority.

versions

list / elements=string

Versions.

Choices:

  • "ssl-3.0"

  • "tls-1.0"

  • "tls-1.1"

  • "tls-1.2"

  • "tls-1.3"

ssl_client_fallback

aliases: ssl-client-fallback

string

Ssl client fallback.

Choices:

  • "disable"

  • "enable"

ssl_client_rekey_count

aliases: ssl-client-rekey-count

integer

Ssl client rekey count.

ssl_client_renegotiation

aliases: ssl-client-renegotiation

string

Ssl client renegotiation.

Choices:

  • "allow"

  • "deny"

  • "secure"

ssl_client_session_state_max

aliases: ssl-client-session-state-max

integer

Ssl client session state max.

ssl_client_session_state_timeout

aliases: ssl-client-session-state-timeout

integer

Ssl client session state timeout.

ssl_client_session_state_type

aliases: ssl-client-session-state-type

string

Ssl client session state type.

Choices:

  • "disable"

  • "time"

  • "count"

  • "both"

ssl_dh_bits

aliases: ssl-dh-bits

string

Ssl dh bits.

Choices:

  • "768"

  • "1024"

  • "1536"

  • "2048"

  • "3072"

  • "4096"

ssl_hpkp

aliases: ssl-hpkp

string

Ssl hpkp.

Choices:

  • "disable"

  • "enable"

  • "report-only"

ssl_hpkp_age

aliases: ssl-hpkp-age

integer

Ssl hpkp age.

ssl_hpkp_backup

aliases: ssl-hpkp-backup

list / elements=string

Ssl hpkp backup.

ssl_hpkp_include_subdomains

aliases: ssl-hpkp-include-subdomains

string

Ssl hpkp include subdomains.

Choices:

  • "disable"

  • "enable"

ssl_hpkp_primary

aliases: ssl-hpkp-primary

list / elements=string

Ssl hpkp primary.

ssl_hpkp_report_uri

aliases: ssl-hpkp-report-uri

string

Ssl hpkp report uri.

ssl_hsts

aliases: ssl-hsts

string

Ssl hsts.

Choices:

  • "disable"

  • "enable"

ssl_hsts_age

aliases: ssl-hsts-age

integer

Ssl hsts age.

ssl_hsts_include_subdomains

aliases: ssl-hsts-include-subdomains

string

Ssl hsts include subdomains.

Choices:

  • "disable"

  • "enable"

ssl_http_location_conversion

aliases: ssl-http-location-conversion

string

Ssl http location conversion.

Choices:

  • "disable"

  • "enable"

ssl_http_match_host

aliases: ssl-http-match-host

string

Ssl http match host.

Choices:

  • "disable"

  • "enable"

ssl_max_version

aliases: ssl-max-version

string

Ssl max version.

Choices:

  • "ssl-3.0"

  • "tls-1.0"

  • "tls-1.1"

  • "tls-1.2"

  • "tls-1.3"

ssl_min_version

aliases: ssl-min-version

string

Ssl min version.

Choices:

  • "ssl-3.0"

  • "tls-1.0"

  • "tls-1.1"

  • "tls-1.2"

  • "tls-1.3"

ssl_mode

aliases: ssl-mode

string

Ssl mode.

Choices:

  • "half"

  • "full"

ssl_pfs

aliases: ssl-pfs

string

Ssl pfs.

Choices:

  • "require"

  • "deny"

  • "allow"

ssl_send_empty_frags

aliases: ssl-send-empty-frags

string

Ssl send empty frags.

Choices:

  • "disable"

  • "enable"

ssl_server_algorithm

aliases: ssl-server-algorithm

string

Ssl server algorithm.

Choices:

  • "high"

  • "low"

  • "medium"

  • "custom"

  • "client"

ssl_server_cipher_suites

aliases: ssl-server-cipher-suites

list / elements=dictionary

Ssl server cipher suites.

cipher

string

Cipher.

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"

priority

integer

Priority.

versions

list / elements=string

Versions.

Choices:

  • "ssl-3.0"

  • "tls-1.0"

  • "tls-1.1"

  • "tls-1.2"

  • "tls-1.3"

ssl_server_max_version

aliases: ssl-server-max-version

string

Ssl server max version.

Choices:

  • "ssl-3.0"

  • "tls-1.0"

  • "tls-1.1"

  • "tls-1.2"

  • "client"

  • "tls-1.3"

ssl_server_min_version

aliases: ssl-server-min-version

string

Ssl server min version.

Choices:

  • "ssl-3.0"

  • "tls-1.0"

  • "tls-1.1"

  • "tls-1.2"

  • "client"

  • "tls-1.3"

ssl_server_renegotiation

aliases: ssl-server-renegotiation

string

Ssl server renegotiation.

Choices:

  • "disable"

  • "enable"

ssl_server_session_state_max

aliases: ssl-server-session-state-max

integer

Ssl server session state max.

ssl_server_session_state_timeout

aliases: ssl-server-session-state-timeout

integer

Ssl server session state timeout.

ssl_server_session_state_type

aliases: ssl-server-session-state-type

string

Ssl server session state type.

Choices:

  • "disable"

  • "time"

  • "count"

  • "both"

status

string

Status.

Choices:

  • "disable"

  • "enable"

svr_pool_multiplex

aliases: svr-pool-multiplex

string

Svr pool multiplex.

Choices:

  • "disable"

  • "enable"

svr_pool_server_max_concurrent_request

aliases: svr-pool-server-max-concurrent-request

integer

Svr pool server max concurrent request.

svr_pool_server_max_request

aliases: svr-pool-server-max-request

integer

Svr pool server max request.

svr_pool_ttl

aliases: svr-pool-ttl

integer

Svr pool ttl.

url_route

aliases: url-route

list / elements=dictionary

Url route.

name

string

Name.

service_connector

aliases: service-connector

list / elements=string

Service connector.

url_pattern

aliases: url-pattern

string

Url pattern.

user_agent_detect

aliases: user-agent-detect

string

User agent detect.

Choices:

  • "disable"

  • "enable"

vip

list / elements=string

Virtual IP name.

vip6

list / elements=string

Virtual IPv6 name.

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • 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

- 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.fortimanager.fmgr_ztna_trafficforwardproxy:
        # bypass_validation: false
        # workspace_locking_adom: <global or your adom name>
        # workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        ztna_trafficforwardproxy:
          name: "your value" # Required variable, string
          # auth_portal: <value in [disable, enable]>
          # auth_virtual_host: <list or string>
          # decrypted_traffic_mirror: <list or string>
          # host: <list or string>
          # log_blocked_traffic: <value in [disable, enable]>
          # url_route:
          #   - name: <string>
          #     service_connector: <list or string>
          #     url_pattern: <string>
          # vip: <list or string>
          # ssl_client_session_state_max: <integer>
          # ssl_send_empty_frags: <value in [disable, enable]>
          # ssl_server_max_version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
          # ssl_accept_ffdhe_groups: <value in [disable, enable]>
          # empty_cert_action: <value in [accept, block, accept-unmanageable]>
          # quic:
          #   ack_delay_exponent: <integer>
          #   active_connection_id_limit: <integer>
          #   active_migration: <value in [disable, enable]>
          #   grease_quic_bit: <value in [disable, enable]>
          #   max_ack_delay: <integer>
          #   max_datagram_frame_size: <integer>
          #   max_idle_timeout: <integer>
          #   max_udp_payload_size: <integer>
          # ssl_server_session_state_max: <integer>
          # ssl_client_session_state_type: <value in [disable, time, count, ...]>
          # ssl_hpkp_age: <integer>
          # ssl_hpkp_report_uri: <string>
          # ssl_min_version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
          # ssl_mode: <value in [half, full]>
          # ssl_client_session_state_timeout: <integer>
          # ssl_hsts_age: <integer>
          # interface: <list or string>
          # ssl_client_renegotiation: <value in [allow, deny, secure]>
          # ssl_server_session_state_timeout: <integer>
          # ssl_server_min_version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
          # ssl_cipher_suites:
          #   - cipher: <value in [TLS-RSA-WITH-RC4-128-MD5, TLS-RSA-WITH-RC4-128-SHA, TLS-RSA-WITH-DES-CBC-SHA, ...]>
          #     priority: <integer>
          #     versions:
          #       - "ssl-3.0"
          #       - "tls-1.0"
          #       - "tls-1.1"
          #       - "tls-1.2"
          #       - "tls-1.3"
          # ssl_client_rekey_count: <integer>
          # svr_pool_server_max_request: <integer>
          # ssl_dh_bits: <value in [768, 1024, 1536, ...]>
          # port: <string>
          # ssl_http_match_host: <value in [disable, enable]>
          # ssl_server_session_state_type: <value in [disable, time, count, ...]>
          # status: <value in [disable, enable]>
          # svr_pool_multiplex: <value in [disable, enable]>
          # ssl_hpkp: <value in [disable, enable, report-only]>
          # ssl_hsts: <value in [disable, enable]>
          # svr_pool_server_max_concurrent_request: <integer>
          # h3_support: <value in [disable, enable]>
          # ssl_http_location_conversion: <value in [disable, enable]>
          # comment: <string>
          # ssl_pfs: <value in [require, deny, allow]>
          # ssl_hsts_include_subdomains: <value in [disable, enable]>
          # ssl_certificate: <list or string>
          # ssl_max_version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
          # ssl_hpkp_backup: <list or string>
          # client_cert: <value in [disable, enable]>
          # ssl_client_fallback: <value in [disable, enable]>
          # vip6: <list or string>
          # ssl_algorithm: <value in [high, low, medium, ...]>
          # ssl_server_algorithm: <value in [high, low, medium, ...]>
          # ssl_hpkp_include_subdomains: <value in [disable, enable]>
          # user_agent_detect: <value in [disable, enable]>
          # ssl_server_renegotiation: <value in [disable, enable]>
          # svr_pool_ttl: <integer>
          # ssl_server_cipher_suites:
          #   - cipher: <value in [TLS-RSA-WITH-RC4-128-MD5, TLS-RSA-WITH-RC4-128-SHA, TLS-RSA-WITH-DES-CBC-SHA, ...]>
          #     priority: <integer>
          #     versions:
          #       - "ssl-3.0"
          #       - "tls-1.0"
          #       - "tls-1.1"
          #       - "tls-1.2"
          #       - "tls-1.3"
          # ssl_hpkp_primary: <list or string>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)