fortios_ztna_service_connector – Configure ZTNA service connector 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 service_connector 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_service_connector - Configure ZTNA service connector. type: dict more...
    • certificate - The name of the certificate to use for SSL handshake. Source vpn.certificate.local.name. type: str more...
    • connection_mode - Connection mode. type: str choices: forward, reverse more...
    • encryption - Enable/disable Encryption . type: str choices: enable, disable more...
    • forward_address - service-connector address(IP or FQDN). type: str more...
    • forward_destination_cn - CN for forward server. type: str more...
    • forward_port - Port number that forward traffic uses to connect to type: int more...
    • health_check_interval - health check interval(0-600 seconds). type: int more...
    • log - Enable/disable logging of traffic. type: str choices: enable, disable more...
    • name - Service-connector name type: str required: true more...
    • relay_dev_info - Enable/disable device info relay. type: str choices: enable, disable more...
    • relay_user_info - Enable/disable user info relay. type: str choices: enable, disable more...
    • ssl_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, tls-1.3 more...
    • ssl_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, tls-1.3 more...
    • trusted_ca - Trusted CA certificate used by SSL inspection. Source vpn.certificate.ca.name. type: str more...
    • url_map - URL pattern to match. type: str more...

Notes

Note

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

Examples

- name: Configure ZTNA service connector.
  fortinet.fortios.fortios_ztna_service_connector:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      ztna_service_connector:
          certificate: "<your_own_value> (source vpn.certificate.local.name)"
          connection_mode: "forward"
          encryption: "enable"
          forward_address: "<your_own_value>"
          forward_destination_cn: "<your_own_value>"
          forward_port: "0"
          health_check_interval: "60"
          log: "enable"
          name: "default_name_11"
          relay_dev_info: "enable"
          relay_user_info: "enable"
          ssl_max_version: "ssl-3.0"
          ssl_min_version: "ssl-3.0"
          trusted_ca: "<your_own_value> (source vpn.certificate.ca.name)"
          url_map: "<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.