fortinet.fortimanager.fmgr_ztna_destination module – Configure ZTNA destination.

Note

This module is part of the fortinet.fortimanager collection (version 2.15.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_destination.

New in fortinet.fortimanager 2.15.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_destination

dictionary

The top level parameters set.

address

list / elements=string

Address or address group of the ZTNA destination.

conn_type

aliases: conn-type

string

Connection type.

Choices:

  • "traffic-forwarding"

  • "ssh"

domain

string

Wildcard domain name of the ZTNA destination.

external_auth

aliases: external-auth

string

Enable/disable use of external browser as user-agent for SAML user authentication.

Choices:

  • "disable"

  • "enable"

mappedport

string

Port for communicating with the real server.

name

string / required

Destination name.

protocol

string

Protocol type based on IANA numbers.

Choices:

  • "TCP"

  • "UDP"

  • "ALL"

saas_application

aliases: saas-application

list / elements=string

SaaS application controlled by this ZTNA destination.

ssh_client_cert

aliases: ssh-client-cert

list / elements=string

Configure access-proxy SSH client certificate profile.

ssh_host_key

aliases: ssh-host-key

list / elements=string

Configure host keys

ssh_host_key_validation

aliases: ssh-host-key-validation

string

Enable/disable SSH host key validation.

Choices:

  • "disable"

  • "enable"

tunnel_encryption

aliases: tunnel-encryption

string

Tunnel encryption.

Choices:

  • "disable"

  • "enable"

type

string

ZTNA destination type.

Choices:

  • "on-premise"

  • "saas"

uuid

string

Universally Unique Identifier

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.

  • 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

  • To create or update an object, use state present directive.

  • To delete an object, use state absent directive.

Examples

- name: Test ZTNA destinations
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Create a ZTNA destination
      fortinet.fortimanager.fmgr_ztna_destination:
        enable_log: true
        adom: root
        state: present
        ztna_destination:
          name: test_destination

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)