fortinet.fortios.fortios_vpn_ssl_web_realm (2.3.6) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==2.3.6

Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

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

• ansible>=2.15

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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)"

Inputs

    
vdom:
    default: root
    description:
    - 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

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

vpn_ssl_web_realm:
    default: null
    description:
    - Realm.
    suboptions:
      login_page:
        description:
        - Replacement HTML for SSL-VPN login page.
        type: str
      max_concurrent_user:
        description:
        - Maximum concurrent users (0 - 65535, 0 means unlimited).
        type: int
      nas_ip:
        description:
        - IP address used as a NAS-IP to communicate with the RADIUS server.
        type: str
      radius_port:
        description:
        - RADIUS service port number (0 - 65535, 0 means user.radius.radius-port).
        type: int
      radius_server:
        description:
        - RADIUS server associated with realm. Source user.radius.name.
        type: str
      url_path:
        description:
        - URL path to access SSL-VPN login page.
        required: true
        type: str
      virtual_host:
        description:
        - Virtual host name for realm.
        type: str
      virtual_host_only:
        choices:
        - enable
        - disable
        description:
        - Enable/disable enforcement of virtual host method for SSL-VPN client access.
        type: str
      virtual_host_server_cert:
        description:
        - Name of the server certificate to used for this realm. Source vpn.certificate.local.name.
        type: str
    type: dict

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str