ansible.builtin.fortios_vpn_ssl_web_user_group_bookmark (v2.9.27) — module

Configure SSL VPN user group bookmark in Fortinet's FortiOS and FortiGate.

| "added in version" 2.9 of ansible.builtin"

Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

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 user_group_bookmark category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Configure SSL VPN user group bookmark.
    fortios_vpn_ssl_web_user_group_bookmark:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      vpn_ssl_web_user_group_bookmark:
        bookmarks:
         -
            additional_params: "<your_own_value>"
            apptype: "citrix"
            description: "<your_own_value>"
            folder: "<your_own_value>"
            form_data:
             -
                name: "default_name_9"
                value: "<your_own_value>"
            host: "<your_own_value>"
            listening_port: "12"
            load_balancing_info: "<your_own_value>"
            logon_password: "<your_own_value>"
            logon_user: "<your_own_value>"
            name: "default_name_16"
            port: "17"
            preconnection_blob: "<your_own_value>"
            preconnection_id: "19"
            remote_port: "20"
            security: "rdp"
            server_layout: "de-de-qwertz"
            show_status_window: "enable"
            sso: "disable"
            sso_credential: "sslvpn-login"
            sso_credential_sent_once: "enable"
            sso_password: "<your_own_value>"
            sso_username: "<your_own_value>"
            url: "myurl.com"
        name: "default_name_30 (source user.group.name)"

Inputs

    
host:
    description:
    - FortiOS or FortiGate IP address.
    required: false
    type: str

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

https:
    default: true
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol.
    type: bool

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

password:
    default: ''
    description:
    - FortiOS or FortiGate password.
    type: str

username:
    description:
    - FortiOS or FortiGate username.
    required: false
    type: str

ssl_verify:
    default: true
    description:
    - Ensures FortiGate certificate must be verified by a proper CA.
    type: bool

vpn_ssl_web_user_group_bookmark:
    default: null
    description:
    - Configure SSL VPN user group bookmark.
    suboptions:
      bookmarks:
        description:
        - Bookmark table.
        suboptions:
          additional_params:
            description:
            - Additional parameters.
            type: str
          apptype:
            choices:
            - citrix
            - ftp
            - portforward
            - rdp
            - smb
            - ssh
            - telnet
            - vnc
            - web
            description:
            - Application type.
            type: str
          description:
            description:
            - Description.
            type: str
          folder:
            description:
            - Network shared file folder parameter.
            type: str
          form_data:
            description:
            - Form data.
            suboptions:
              name:
                description:
                - Name.
                required: true
                type: str
              value:
                description:
                - Value.
                type: str
            type: list
          host:
            description:
            - Host name/IP parameter.
            type: str
          listening_port:
            description:
            - Listening port (0 - 65535).
            type: int
          load_balancing_info:
            description:
            - The load balancing information or cookie which should be provided to the
              connection broker.
            type: str
          logon_password:
            description:
            - Logon password.
            type: str
          logon_user:
            description:
            - Logon user.
            type: str
          name:
            description:
            - Bookmark name.
            required: true
            type: str
          port:
            description:
            - Remote port.
            type: int
          preconnection_blob:
            description:
            - An arbitrary string which identifies the RDP source.
            type: str
          preconnection_id:
            description:
            - The numeric ID of the RDP source (0-2147483648).
            type: int
          remote_port:
            description:
            - Remote port (0 - 65535).
            type: int
          security:
            choices:
            - rdp
            - nla
            - tls
            - any
            description:
            - Security mode for RDP connection.
            type: str
          server_layout:
            choices:
            - de-de-qwertz
            - en-gb-qwerty
            - en-us-qwerty
            - es-es-qwerty
            - fr-fr-azerty
            - fr-ch-qwertz
            - it-it-qwerty
            - ja-jp-qwerty
            - pt-br-qwerty
            - sv-se-qwerty
            - tr-tr-qwerty
            - failsafe
            description:
            - Server side keyboard layout.
            type: str
          show_status_window:
            choices:
            - enable
            - disable
            description:
            - Enable/disable showing of status window.
            type: str
          sso:
            choices:
            - disable
            - static
            - auto
            description:
            - Single Sign-On.
            type: str
          sso_credential:
            choices:
            - sslvpn-login
            - alternative
            description:
            - Single sign-on credentials.
            type: str
          sso_credential_sent_once:
            choices:
            - enable
            - disable
            description:
            - Single sign-on credentials are only sent once to remote server.
            type: str
          sso_password:
            description:
            - SSO password.
            type: str
          sso_username:
            description:
            - SSO user name.
            type: str
          url:
            description:
            - URL parameter.
            type: str
        type: list
      name:
        description:
        - Group name. Source user.group.name.
        required: true
        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