fmgr_vpnsslweb_portal_bookmarkgroup – Portal bookmark group.

Added in version 2.0.0.

Warning

Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).

  • Argument name before 3.0.0: var-name, var name, var.name

  • New argument name starting in 3.0.0: var_name

FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.

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.

  • Tested with FortiManager v6.x and v7.x.

Requirements

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

  • ansible>=2.15.0

FortiManager Version Compatibility

Supported Version Ranges: v6.0.0 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • 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
  • 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
  • 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
  • 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
  • adom - The parameter in requested url type: str required: true
  • portal - The parameter in requested url type: str required: true
  • vpnsslweb_portal_bookmarkgroup - Portal bookmark group. type: dict
    • bookmarks type: list more...
      • additional_params (Alias name: 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 (Alias name: form-data) type: list more...
        • name Name. type: str more...
        • value Value. type: str more...
      • host Host name/ip parameter. type: str more...
      • listening_port (Alias name: listening-port) Listening port (0 - 65535). type: int more...
      • load_balancing_info (Alias name: load-balancing-info) The load balancing information or cookie which should be provided to the connection broker. type: str more...
      • logon_password (Alias name: logon-password) type: list more...
      • logon_user (Alias name: logon-user) Logon user. type: str more...
      • name Bookmark name. type: str more...
      • port Remote port. type: int more...
      • preconnection_blob (Alias name: preconnection-blob) An arbitrary string which identifies the rdp source. type: str more...
      • preconnection_id (Alias name: preconnection-id) The numeric id of the rdp source (0-2147483648). type: int more...
      • remote_port (Alias name: 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 (Alias name: 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 (Alias name: 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 (Alias name: sso-credential) Single sign-on credentials. type: str choices: [sslvpn-login, alternative] more...
      • sso_credential_sent_once (Alias name: sso-credential-sent-once) Single sign-on credentials are only sent once to remote server. type: str choices: [disable, enable] more...
      • sso_password (Alias name: sso-password) type: list more...
      • sso_username (Alias name: sso-username) Sso user name. type: str more...
      • url Url parameter. type: str more...
      • domain Login domain. type: str more...
      • color_depth (Alias name: 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 (Alias name: 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, la-am, ja-106] more...
      • restricted_admin (Alias name: restricted-admin) Enable/disable restricted admin mode for rdp. type: str choices: [disable, enable] more...
      • send_preconnection_id (Alias name: 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...
      • vnc_keyboard_layout (Alias name: vnc-keyboard-layout) Keyboard layout. type: str 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] 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

- 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: Portal bookmark group.
      fortinet.fortimanager.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: 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, ...]>
          name: <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:

  • meta - The result of the request.returned: always type: dict
    • 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_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

Status

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

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)