Spec-Zone.ru › Ansible

fortinet.fortimanager.fmgr_ztna_webportalbookmark module – Configure ztna web-portal bookmark.

Note

This module is part of the fortinet.fortimanager collection (version 2.14.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_ztna_webportalbookmark.

New in fortinet.fortimanager 2.12.0

  • Synopsis
  • Parameters
  • Notes
  • Examples
  • Return Values

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.

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.

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.

revision_note

string

The change note that can be specified when an object is created or updated.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"
  • "absent"

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

ztna_webportalbookmark

dictionary

The top level parameters set.

bookmarks

list / elements=dictionary

Bookmarks.

apptype

string

Application type.

Choices:

  • "web"
  • "telnet"
  • "ssh"
  • "ftp"
  • "smb"
  • "vnc"
  • "rdp"
  • "sftp"

color_depth

aliases: color-depth

string

Color depth per pixel.

Choices:

  • "8"
  • "16"
  • "32"

description

string

Description.

domain

string

Login domain.

folder

string

Network shared file folder parameter.

height

integer

Screen height

host

string

Host name/IP parameter.

keyboard_layout

aliases: keyboard-layout

string

Keyboard layout.

Choices:

  • "da"
  • "de"
  • "de-ch"
  • "en-uk"
  • "en-us"
  • "es"
  • "fi"
  • "fr"
  • "fr-be"
  • "fr-ca"
  • "fr-ch"
  • "hr"
  • "hu"
  • "it"
  • "ja"
  • "lt"
  • "mk"
  • "no"
  • "pt"
  • "pt-br"
  • "ru"
  • "sl"
  • "sv"
  • "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"

load_balancing_info

aliases: load-balancing-info

string

The load balancing information or cookie which should be provided to the connection broker.

logon_password

aliases: logon-password

list / elements=string

Logon password.

logon_user

aliases: logon-user

string

Logon user.

name

string

Bookmark name.

port

integer

Remote port.

preconnection_blob

aliases: preconnection-blob

string

An arbitrary string which identifies the RDP source.

preconnection_id

aliases: preconnection-id

integer

The numeric ID of the RDP source

restricted_admin

aliases: restricted-admin

string

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

aliases: send-preconnection-id

string

Enable/disable sending of preconnection ID.

Choices:

  • "disable"
  • "enable"

sso

string

Single sign-on.

Choices:

  • "disable"
  • "enable"

url

string

URL parameter.

vnc_keyboard_layout

aliases: vnc-keyboard-layout

string

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

groups

list / elements=string

User groups.

llm_secure_proxy

aliases: llm-secure-proxy

dictionary

Llm secure proxy.

all_llm_servers

aliases: all-llm-servers

string

All llm servers.

Choices:

  • "disable"
  • "enable"

llm_servers

aliases: llm-servers

list / elements=string

Llm servers.

name

string / required

Bookmark name.

type

string

Type.

Choices:

  • "user"
  • "ldap-dynamic"
  • "saml-dynamic"

users

list / elements=string

User name.

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.
  • 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
  • To create or update an object, use state present directive.
  • To delete an object, use state absent directive.

Examples

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure ztna web-portal bookmark.
      fortinet.fortimanager.fmgr_ztna_webportalbookmark:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        ztna_webportalbookmark:
          name: "your value" # Required variable, string
          # bookmarks:
          #   - apptype: <value in [web, telnet, ssh, ...]>
          #     color_depth: <value in [8, 16, 32]>
          #     description: <string>
          #     domain: <string>
          #     folder: <string>
          #     height: <integer>
          #     host: <string>
          #     keyboard_layout: <value in [da, de, de-ch, ...]>
          #     load_balancing_info: <string>
          #     logon_password: <list or string>
          #     logon_user: <string>
          #     name: <string>
          #     port: <integer>
          #     preconnection_blob: <string>
          #     preconnection_id: <integer>
          #     restricted_admin: <value in [disable, enable]>
          #     security: <value in [rdp, nla, tls, ...]>
          #     send_preconnection_id: <value in [disable, enable]>
          #     sso: <value in [disable, enable]>
          #     url: <string>
          #     vnc_keyboard_layout: <value in [da, de, de-ch, ...]>
          #     width: <integer>
          # groups: <list or string>
          # type: <value in [user, ldap-dynamic, saml-dynamic]>
          # users: <list or string>
          # llm_secure_proxy:
          #   all_llm_servers: <value in [disable, enable]>
          #   llm_servers: <list or string>

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)

Collection links

  • Issue Tracker
  • Homepage
  • Repository (Sources)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API