fortinet.fortimanager.fmgr_vpnsslweb_portal_bookmarkgroup_bookmarks module – Bookmark table.

Note

This module is part of the fortinet.fortimanager collection (version 2.7.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_vpnsslweb_portal_bookmarkgroup_bookmarks.

New in fortinet.fortimanager 2.0.0

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter

Comments

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bookmark-group

string

Deprecated, please use “bookmark_group”

bookmark_group

string

The parameter (bookmark-group) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

portal

string / required

The parameter (portal) in requested url.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

vpnsslweb_portal_bookmarkgroup_bookmarks

dictionary

The top level parameters set.

additional-params

string

Deprecated, please rename it to additional_params. Additional parameters.

apptype

string

Application type.

Choices:

  • "web"

  • "telnet"

  • "ssh"

  • "ftp"

  • "smb"

  • "vnc"

  • "rdp"

  • "citrix"

  • "rdpnative"

  • "portforward"

  • "sftp"

color-depth

string

Deprecated, please rename it to color_depth. Color depth per pixel.

Choices:

  • "8"

  • "16"

  • "32"

description

string

Description.

domain

string

Login domain.

folder

string

Network shared file folder parameter.

form-data

list / elements=dictionary

Deprecated, please rename it to form_data. Form data.

name

string

Name.

value

string

Value.

height

integer

Screen height

host

string

Host name/IP parameter.

keyboard-layout

string

Deprecated, please rename it to keyboard_layout. Keyboard layout.

Choices:

  • "ar"

  • "da"

  • "de"

  • "de-ch"

  • "en-gb"

  • "en-uk"

  • "en-us"

  • "es"

  • "fi"

  • "fr"

  • "fr-be"

  • "fr-ca"

  • "fr-ch"

  • "hr"

  • "hu"

  • "it"

  • "ja"

  • "lt"

  • "lv"

  • "mk"

  • "no"

  • "pl"

  • "pt"

  • "pt-br"

  • "ru"

  • "sl"

  • "sv"

  • "tk"

  • "tr"

  • "fr-ca-m"

  • "wg"

  • "ar-101"

  • "ar-102"

  • "ar-102-azerty"

  • "can-mul"

  • "cz"

  • "cz-qwerty"

  • "cz-pr"

  • "nl"

  • "de-ibm"

  • "en-uk-ext"

  • "en-us-dvorak"

  • "es-var"

  • "fi-sami"

  • "hu-101"

  • "it-142"

  • "ko"

  • "lt-ibm"

  • "lt-std"

  • "lav-std"

  • "lav-leg"

  • "mk-std"

  • "no-sami"

  • "pol-214"

  • "pol-pr"

  • "pt-br-abnt2"

  • "ru-mne"

  • "ru-t"

  • "sv-sami"

  • "tuk"

  • "tur-f"

  • "tur-q"

  • "zh-sym-sg-us"

  • "zh-sym-us"

  • "zh-tr-hk"

  • "zh-tr-mo"

  • "zh-tr-us"

  • "fr-apple"

  • "la-am"

  • "ja-106"

listening-port

integer

Deprecated, please rename it to listening_port. Listening port

load-balancing-info

string

Deprecated, please rename it to load_balancing_info. The load balancing information or cookie which should be provided to …

logon-password

any

(list) Deprecated, please rename it to logon_password. Logon password.

logon-user

string

Deprecated, please rename it to logon_user. Logon user.

name

string / required

Bookmark name.

port

integer

Remote port.

preconnection-blob

string

Deprecated, please rename it to preconnection_blob. An arbitrary string which identifies the RDP source.

preconnection-id

integer

Deprecated, please rename it to preconnection_id. The numeric ID of the RDP source

remote-port

integer

Deprecated, please rename it to remote_port. Remote port

restricted-admin

string

Deprecated, please rename it to restricted_admin. Enable/disable restricted admin mode for RDP.

Choices:

  • "disable"

  • "enable"

security

string

Security mode for RDP connection.

Choices:

  • "rdp"

  • "nla"

  • "tls"

  • "any"

send-preconnection-id

string

Deprecated, please rename it to send_preconnection_id. Enable/disable sending of preconnection ID.

Choices:

  • "disable"

  • "enable"

server-layout

string

Deprecated, please rename it to server_layout. Server side keyboard layout.

Choices:

  • "en-us-qwerty"

  • "de-de-qwertz"

  • "fr-fr-azerty"

  • "it-it-qwerty"

  • "sv-se-qwerty"

  • "failsafe"

  • "en-gb-qwerty"

  • "es-es-qwerty"

  • "fr-ch-qwertz"

  • "ja-jp-qwerty"

  • "pt-br-qwerty"

  • "tr-tr-qwerty"

  • "fr-ca-qwerty"

show-status-window

string

Deprecated, please rename it to show_status_window. Enable/disable showing of status window.

Choices:

  • "disable"

  • "enable"

sso

string

Single Sign-On.

Choices:

  • "disable"

  • "static"

  • "auto"

sso-credential

string

Deprecated, please rename it to sso_credential. Single sign-on credentials.

Choices:

  • "sslvpn-login"

  • "alternative"

sso-credential-sent-once

string

Deprecated, please rename it to sso_credential_sent_once. Single sign-on credentials are only sent once to remote server.

Choices:

  • "disable"

  • "enable"

sso-password

any

(list) Deprecated, please rename it to sso_password. SSO password.

sso-username

string

Deprecated, please rename it to sso_username. SSO user name.

url

string

URL parameter.

vnc-keyboard-layout

string

Deprecated, please rename it to vnc_keyboard_layout. Keyboard layout.

Choices:

  • "da"

  • "de"

  • "de-ch"

  • "en-uk"

  • "es"

  • "fi"

  • "fr"

  • "fr-be"

  • "it"

  • "no"

  • "pt"

  • "sv"

  • "nl"

  • "en-uk-ext"

  • "it-142"

  • "pt-br-abnt2"

  • "default"

  • "fr-ca-mul"

  • "gd"

  • "us-intl"

width

integer

Screen width

workspace_locking_adom

string

The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state present directive.

  • To delete an object, use state absent directive.

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Bookmark table.
      fortinet.fortimanager.fmgr_vpnsslweb_portal_bookmarkgroup_bookmarks:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        portal: <your own value>
        bookmark_group: <your own value>
        state: present # <value in [present, absent]>
        vpnsslweb_portal_bookmarkgroup_bookmarks:
          additional_params: <string>
          apptype: <value in [web, telnet, ssh, ...]>
          description: <string>
          folder: <string>
          form_data:
            -
              name: <string>
              value: <string>
          host: <string>
          listening_port: <integer>
          load_balancing_info: <string>
          logon_password: <list or string>
          logon_user: <string>
          name: <string>
          port: <integer>
          preconnection_blob: <string>
          preconnection_id: <integer>
          remote_port: <integer>
          security: <value in [rdp, nla, tls, ...]>
          server_layout: <value in [en-us-qwerty, de-de-qwertz, fr-fr-azerty, ...]>
          show_status_window: <value in [disable, enable]>
          sso: <value in [disable, static, auto]>
          sso_credential: <value in [sslvpn-login, alternative]>
          sso_credential_sent_once: <value in [disable, enable]>
          sso_password: <list or string>
          sso_username: <string>
          url: <string>
          domain: <string>
          color_depth: <value in [8, 16, 32]>
          height: <integer>
          keyboard_layout: <value in [ar, da, de, ...]>
          restricted_admin: <value in [disable, enable]>
          send_preconnection_id: <value in [disable, enable]>
          width: <integer>
          vnc_keyboard_layout: <value in [da, de, de-ch, ...]>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)