W3cubDocs

/Ansible 2.11

fortinet.fortimanager.fmgr_vpnsslweb_portal_bookmarkgroup_bookmarks – Bookmark table.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.0.1).

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 version 2.10: of fortinet.fortimanager

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 Choices/Defaults Comments
adom
string / required
the parameter (adom) in requested url
bookmark-group
string / required
the parameter (bookmark-group) in requested url
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
portal
string / required
the parameter (portal) in requested url
rc_failed
list / elements=string
the rc codes list with which the conditions to fail will be overriden
rc_succeeded
list / elements=string
the rc codes list with which the conditions to succeed will be overriden
state
string / required
    Choices:
  • present
  • absent
the directive to create, update or delete an object
vpnsslweb_portal_bookmarkgroup_bookmarks
dictionary
the top level parameters set
additional-params
string
Additional parameters.
apptype
string
    Choices:
  • web
  • telnet
  • ssh
  • ftp
  • smb
  • vnc
  • rdp
  • citrix
  • rdpnative
  • portforward
  • sftp
Application type.
description
string
Description.
folder
string
Network shared file folder parameter.
form-data
list / elements=string
no description
name
string
Name.
value
string
Value.
host
string
Host name/IP parameter.
listening-port
integer
Listening port (0 - 65535).
load-balancing-info
string
The load balancing information or cookie which should be provided to the connection broker.
logon-password
string
no description
logon-user
string
Logon user.
name
string
Bookmark name.
port
integer
Remote port.
preconnection-blob
string
An arbitrary string which identifies the RDP source.
preconnection-id
integer
The numeric ID of the RDP source (0-2147483648).
remote-port
integer
Remote port (0 - 65535).
security
string
    Choices:
  • rdp
  • nla
  • tls
  • any
Security mode for RDP connection.
server-layout
string
    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
Server side keyboard layout.
show-status-window
string
    Choices:
  • disable
  • enable
Enable/disable showing of status window.
sso
string
    Choices:
  • disable
  • static
  • auto
Single Sign-On.
sso-credential
string
    Choices:
  • sslvpn-login
  • alternative
Single sign-on credentials.
sso-credential-sent-once
string
    Choices:
  • disable
  • enable
Single sign-on credentials are only sent once to remote server.
sso-password
string
no description
sso-username
string
SSO user name.
url
string
URL parameter.
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
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock

Notes

Note

  • 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

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Bookmark table.
     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: <value in [present, absent]>
        vpnsslweb_portal_bookmarkgroup_bookmarks:
           additional-params: <value of string>
           apptype: <value in [web, telnet, ssh, ...]>
           description: <value of string>
           folder: <value of string>
           form-data:
             -
                 name: <value of string>
                 value: <value of string>
           host: <value of string>
           listening-port: <value of integer>
           load-balancing-info: <value of string>
           logon-password: <value of string>
           logon-user: <value of string>
           name: <value of string>
           port: <value of integer>
           preconnection-blob: <value of string>
           preconnection-id: <value of integer>
           remote-port: <value of 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: <value of string>
           sso-username: <value of string>
           url: <value of string>

Return Values

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

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request
response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_vpnsslweb_portal_bookmarkgroup_bookmarks_module.html