fortios_ztna_destination – Configure ZTNA destination in Fortinet’s FortiOS and FortiGate.

Added in version 2.0.0.

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify ztna feature and destination 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: v8.0.0

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • ztna_destination - Configure ZTNA destination. type: dict more...
    • address - Address or address group of the ZTNA destination. Source firewall.address.name firewall.addrgrp.name. type: str more...
    • conn_type - Connection type. type: str choices: traffic-forwarding, ssh more...
    • domain - Wildcard domain name of the ZTNA destination. type: str more...
    • external_auth - Enable/disable use of external browser as user-agent for SAML user authentication. type: str choices: enable, disable more...
    • mappedport - Port for communicating with the real server. type: str more...
    • name - Destination name. type: str required: true more...
    • protocol - Protocol type based on IANA numbers. type: str choices: TCP, UDP, ALL more...
    • saas_application - SaaS application controlled by this ZTNA destination. type: list member_path: saas_application:name more...
      • name - SaaS application name. type: str required: true more...
    • ssh_client_cert - Configure access-proxy SSH client certificate profile. Source firewall.access-proxy-ssh-client-cert.name. type: str more...
    • ssh_host_key - Configure host keys (one or more may be configured). type: list member_path: ssh_host_key:name more...
      • name - Host key name. Source firewall.ssh.host-key.name. type: str required: true more...
    • ssh_host_key_validation - Enable/disable SSH host key validation. type: str choices: disable, enable more...
    • tunnel_encryption - Tunnel encryption. type: str choices: enable, disable more...
    • type - ZTNA destination type. type: str choices: on-premise, saas more...
    • uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure ZTNA destination.
  fortinet.fortios.fortios_ztna_destination:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      ztna_destination:
          address: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
          conn_type: "traffic-forwarding"
          domain: "<your_own_value>"
          external_auth: "enable"
          mappedport: "<your_own_value>"
          name: "default_name_8"
          protocol: "TCP"
          saas_application:
              -
                  name: "default_name_11"
          ssh_client_cert: "<your_own_value> (source firewall.access-proxy-ssh-client-cert.name)"
          ssh_host_key:
              -
                  name: "default_name_14 (source firewall.ssh.host-key.name)"
          ssh_host_key_validation: "disable"
          tunnel_encryption: "enable"
          type: "on-premise"
          uuid: "<your_own_value>"

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:

  • 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.