Skip to content

Latest commit

 

History

History
423 lines (379 loc) · 18 KB

fortios_vpn_ssl_client.rst

File metadata and controls

423 lines (379 loc) · 18 KB
Raw
source:fortios_vpn_ssl_client.py
orphan:

fortios_vpn_ssl_client -- Client in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis

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

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility


Supported Version Ranges
fortios_vpn_ssl_client v7.0.0 -> latest

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
  • vpn_ssl_client - Client. type: dict more...
    Supported Version Ranges
    vpn_ssl_client v7.0.0 -> latest
    • certificate - Certificate to offer to SSL-VPN server if it requests one. Source vpn.certificate.local.name. type: str more...
      Supported Version Ranges
      certificate v7.0.0 -> latest
    • class_id - Traffic class ID. Source firewall.traffic-class.class-id. type: int more...
      Supported Version Ranges
      class_id v7.2.0 -> latest
    • comment - Comment. type: str more...
      Supported Version Ranges
      comment v7.0.0 -> latest
    • distance - Distance for routes added by SSL-VPN (1 - 255). type: int more...
      Supported Version Ranges
      distance v7.0.0 -> latest
    • interface - SSL interface to send/receive traffic over. Source system.interface.name. type: str more...
      Supported Version Ranges
      interface v7.0.0 -> latest
    • ipv4_subnets - IPv4 subnets that the client is protecting. Source firewall.address.name firewall.addrgrp.name. type: str more...
      Supported Version Ranges
      ipv4_subnets v7.2.4 -> latest
    • ipv6_subnets - IPv6 subnets that the client is protecting. Source firewall.address6.name firewall.addrgrp6.name. type: str more...
      Supported Version Ranges
      ipv6_subnets v7.2.4 -> latest
    • name - SSL-VPN tunnel name. type: str required: true more...
      Supported Version Ranges
      name v7.0.0 -> latest
    • peer - Authenticate peer"s certificate with the peer/peergrp. Source user.peer.name user.peergrp.name. type: str more...
      Supported Version Ranges
      peer v7.0.0 -> latest
    • port - SSL-VPN server port. type: int more...
      Supported Version Ranges
      port v7.0.0 -> latest
    • priority - Priority for routes added by SSL-VPN (1 - 65535). type: int more...
      Supported Version Ranges
      priority v7.0.0 -> latest
    • psk - Pre-shared secret to authenticate with the server (ASCII string or hexadecimal encoded with a leading 0x). type: str more...
      Supported Version Ranges
      psk v7.0.0 -> latest
    • realm - Realm name configured on SSL-VPN server. type: str more...
      Supported Version Ranges
      realm v7.0.1 -> latest
    • server - IPv4, IPv6 or DNS address of the SSL-VPN server. type: str more...
      Supported Version Ranges
      server v7.0.0 -> latest
    • source_ip - IPv4 or IPv6 address to use as a source for the SSL-VPN connection to the server. type: str more...
      Supported Version Ranges
      source_ip v7.0.0 -> latest
    • status - Enable/disable this SSL-VPN client configuration. type: str choices: enable, disable more...
      Supported Version Ranges
      status v7.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • user - Username to offer to the peer to authenticate the client. type: str more...
      Supported Version Ranges
      user v7.0.0 -> latest

Notes

Note

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

Examples

- name: Client.
  fortinet.fortios.fortios_vpn_ssl_client:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      vpn_ssl_client:
          certificate: "<your_own_value> (source vpn.certificate.local.name)"
          class_id: "0"
          comment: "Comment."
          distance: "10"
          interface: "<your_own_value> (source system.interface.name)"
          ipv4_subnets: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
          ipv6_subnets: "<your_own_value> (source firewall.address6.name firewall.addrgrp6.name)"
          name: "default_name_10"
          peer: "<your_own_value> (source user.peer.name user.peergrp.name)"
          port: "443"
          priority: "1"
          psk: "<your_own_value>"
          realm: "<your_own_value>"
          server: "192.168.100.40"
          source_ip: "84.230.14.43"
          status: "enable"
          user: "<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.