fmgr_vpnsslweb_portal_bookmarkgroup – Portal bookmark group.

New in version 2.10.

Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values need to be adjusted to data sources before usage.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
vpnsslweb_portal_bookmarkgroup yes yes yes yes yes yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • adom - The parameter in requested url type: str required: true
  • portal - The parameter in requested url type: str required: true
  • vpnsslweb_portal_bookmarkgroup - no description type: dict
    • bookmarks - No description for the parameter type: array more...
      • additional-params - Additional parameters. type: str more...
      • apptype - Application type. type: str choices: [web, telnet, ssh, ftp, smb, vnc, rdp, citrix, rdpnative, portforward, sftp] more...
      • description - Description. type: str more...
      • folder - Network shared file folder parameter. type: str more...
      • form-data - No description for the parameter type: array more...
        • name - Name. type: str more...
        • value - Value. type: str more...
      • host - Host name/IP parameter. type: str more...
      • listening-port - Listening port (0 - 65535). type: int more...
      • load-balancing-info - The load balancing information or cookie which should be provided to the connection broker. type: str more...
      • logon-password - No description for the parameter type: str more...
      • logon-user - Logon user. type: str more...
      • name - Bookmark name. type: str more...
      • port - Remote port. type: int more...
      • preconnection-blob - An arbitrary string which identifies the RDP source. type: str more...
      • preconnection-id - The numeric ID of the RDP source (0-2147483648). type: int more...
      • remote-port - Remote port (0 - 65535). type: int more...
      • security - Security mode for RDP connection. type: str choices: [rdp, nla, tls, any] more...
      • server-layout - Server side keyboard layout. type: str 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] more...
      • show-status-window - Enable/disable showing of status window. type: str choices: [disable, enable] more...
      • sso - Single Sign-On. type: str choices: [disable, static, auto] more...
      • sso-credential - Single sign-on credentials. type: str choices: [sslvpn-login, alternative] more...
      • sso-credential-sent-once - Single sign-on credentials are only sent once to remote server. type: str choices: [disable, enable] more...
      • sso-password - No description for the parameter type: str more...
      • sso-username - SSO user name. type: str more...
      • url - URL parameter. type: str more...
      • domain - Login domain. type: str more...
      • color-depth - Color depth per pixel. type: str choices: [8, 16, 32] more...
      • height - Screen height (range from 0 - 65535, default = 0). type: int more...
      • keyboard-layout - Keyboard layout. type: str 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] more...
      • restricted-admin - Enable/disable restricted admin mode for RDP. type: str choices: [disable, enable] more...
      • send-preconnection-id - Enable/disable sending of preconnection ID. type: str choices: [disable, enable] more...
      • width - Screen width (range from 0 - 65535, default = 0). type: int more...
    • name - Bookmark group name. type: str more...

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: no description
     fmgr_vpnsslweb_portal_bookmarkgroup:
        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>
        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>
                 domain: <value of string>
                 color-depth: <value in [8, 16, 32]>
                 height: <value of integer>
                 keyboard-layout: <value in [ar, da, de, ...]>
                 restricted-admin: <value in [disable, enable]>
                 send-preconnection-id: <value in [disable, enable]>
                 width: <value of integer>
           name: <value of string>

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:

  • request_url - The full url requested returned: always type: str sample: /sys/login/user
  • response_code - The status of api request returned: always type: int sample: 0
  • response_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

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

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.