Skip to content

Latest commit

 

History

History
296 lines (252 loc) · 12.9 KB

fortios_vpn_ssl_web_realm.rst

File metadata and controls

296 lines (252 loc) · 12.9 KB
Raw
source:fortios_vpn_ssl_web_realm.py
orphan:

fortios_vpn_ssl_web_realm -- Realm 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_web feature and realm 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_web_realm v6.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_web_realm - Realm. type: dict more...
    Supported Version Ranges
    vpn_ssl_web_realm v6.0.0 -> latest
    • login_page - Replacement HTML for SSL-VPN login page. type: str more...
      Supported Version Ranges
      login_page v6.0.0 -> latest
    • max_concurrent_user - Maximum concurrent users (0 - 65535, 0 means unlimited). type: int more...
      Supported Version Ranges
      max_concurrent_user v6.0.0 -> latest
    • nas_ip - IP address used as a NAS-IP to communicate with the RADIUS server. type: str more...
      Supported Version Ranges
      nas_ip v6.4.0 -> latest
    • radius_port - RADIUS service port number (0 - 65535, 0 means user.radius.radius-port). type: int more...
      Supported Version Ranges
      radius_port v6.4.0 -> v6.4.0 v6.4.4 -> latest
    • radius_server - RADIUS server associated with realm. Source user.radius.name. type: str more...
      Supported Version Ranges
      radius_server v6.4.0 -> latest
    • url_path - URL path to access SSL-VPN login page. type: str required: true more...
      Supported Version Ranges
      url_path v6.0.0 -> latest
    • virtual_host - Virtual host name for realm. type: str more...
      Supported Version Ranges
      virtual_host v6.0.0 -> latest
    • virtual_host_only - Enable/disable enforcement of virtual host method for SSL-VPN client access. type: str choices: enable, disable more...
      Supported Version Ranges
      virtual_host_only v6.4.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • virtual_host_server_cert - Name of the server certificate to used for this realm. Source vpn.certificate.local.name. type: str more...
      Supported Version Ranges
      virtual_host_server_cert v7.0.2 -> latest

Notes

Note

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

Examples

- name: Realm.
  fortinet.fortios.fortios_vpn_ssl_web_realm:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      vpn_ssl_web_realm:
          login_page: "<your_own_value>"
          max_concurrent_user: "0"
          nas_ip: "<your_own_value>"
          radius_port: "0"
          radius_server: "<your_own_value> (source user.radius.name)"
          url_path: "<your_own_value>"
          virtual_host: "myhostname"
          virtual_host_only: "enable"
          virtual_host_server_cert: "myhostname (source vpn.certificate.local.name)"

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.