fortinet.fortimanager.fmgr_vpnsslweb_portal_bookmarkgroup 模块 – 门户书签组。

注意

此模块是 fortinet.fortimanager 集合（版本 2.8.2）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install fortinet.fortimanager。

要在 playbook 中使用它，请指定：fortinet.fortimanager.fmgr_vpnsslweb_portal_bookmarkgroup。

在 fortinet.fortimanager 2.0.0 中新增

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包括所有参数和值，这些参数和值在使用前需要根据数据源进行调整。

参数

参数

注释

access_token

字符串

用于访问 FortiManager 而无需使用用户名和密码的令牌。

adom

字符串 / 必填

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

仅当模块架构与 FortiManager API 结构不同时才设置为 True，模块将继续执行而不验证参数。

选项

  • false ← (默认)

  • true

enable_log

布尔值

启用/禁用任务的日志记录。

选项

  • false ← (默认)

  • true

forticloud_access_token

字符串

使用 forticloud API 访问令牌验证 Ansible 客户端。

portal

字符串 / 必填

请求 URL 中的参数 (portal)。

proposed_method

字符串

覆盖底层 Json RPC 请求的方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

将覆盖失败条件的 rc 代码列表。

rc_succeeded

列表 / 元素=整数

将覆盖成功条件的 rc 代码列表。

state

字符串 / 必填

用于创建、更新或删除对象的指令。

选项

  • "present"

  • "absent"

vpnsslweb_portal_bookmarkgroup

字典

设置的顶级参数。

bookmarks

列表 / 元素=字典

书签。

additional_params

别名：additional-params

字符串

其他参数。

apptype

字符串

应用程序类型。

选项

  • "web"

  • "telnet"

  • "ssh"

  • "ftp"

  • "smb"

  • "vnc"

  • "rdp"

  • "citrix"

  • "rdpnative"

  • "portforward"

  • "sftp"

color_depth

别名：color-depth

字符串

每个像素的颜色深度。

选项

  • "8"

  • "16"

  • "32"

description

字符串

描述。

domain

字符串

登录域。

folder

字符串

网络共享文件文件夹参数。

form_data

别名：form-data

列表 / 元素=字典

表单数据。

name

字符串

名称。

value

字符串

值。

height

整数

屏幕高度

host

字符串

主机名/IP 参数。

keyboard_layout

别名：keyboard-layout

字符串

键盘布局。

选项

  • "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

别名：listening-port

整数

监听端口

load_balancing_info

别名：load-balancing-info

字符串

应提供给连接代理的负载平衡信息或 cookie。

logon_password

别名：logon-password

任意

（列表）登录密码。

logon_user

别名：logon-user

字符串

登录用户。

name

字符串

书签名称。

port

整数

远程端口。

preconnection_blob

别名：preconnection-blob

字符串

标识 RDP 源的任意字符串。

preconnection_id

别名：preconnection-id

整数

RDP 源的数字 ID

remote_port

别名：remote-port

整数

远程端口

restricted_admin

别名: restricted-admin

字符串

启用/禁用 RDP 的受限管理员模式。

选项

  • "disable" (禁用)

  • "enable" (启用)

security (安全)

字符串

RDP 连接的安全模式。

选项

  • "rdp"

  • "nla"

  • "tls"

  • "any" (任意)

send_preconnection_id

别名: send-preconnection-id

字符串

启用/禁用发送预连接 ID。

选项

  • "disable" (禁用)

  • "enable" (启用)

server_layout

别名: server-layout

字符串

服务器端键盘布局。

选项

  • "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

别名: show-status-window

字符串

启用/禁用显示状态窗口。

选项

  • "disable" (禁用)

  • "enable" (启用)

sso

字符串

单点登录 (Single Sign-On)。

选项

  • "disable" (禁用)

  • "static" (静态)

  • "auto" (自动)

sso_credential

别名: sso-credential

字符串

单点登录凭证。

选项

  • "sslvpn-login"

  • "alternative" (备选)

sso_credential_sent_once

别名: sso-credential-sent-once

字符串

单点登录凭证只发送给远程服务器一次。

选项

  • "disable" (禁用)

  • "enable" (启用)

sso_password

别名: sso-password

任意

(列表) SSO 密码。

sso_username

别名: sso-username

字符串

SSO 用户名。

url

字符串

URL 参数。

vnc_keyboard_layout

别名: vnc-keyboard-layout

字符串

键盘布局。

选项

  • "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

整数

屏幕宽度。

name

字符串 / 必填

书签组名称。

workspace_locking_adom

字符串

在工作区模式下运行时，要锁定的 FortiManager 的 ADOM，该值可以是 global 和包括 root 在内的其他值。

workspace_locking_timeout

整数

等待其他用户释放工作区锁定的最大时间（以秒为单位）。

默认值: 300

备注

注意

  • 从 2.4.0 版本开始，所有输入参数都使用下划线命名约定 (snake_case) 命名。请将诸如 “var-name” 之类的参数更改为 “var_name”。旧的参数名称仍然可用，但是您将收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。

  • 此 FortiManager 模块支持在工作区锁定模式下运行，顶级参数 workspace_locking_adom 和 workspace_locking_timeout 可帮助完成此工作。

  • 要创建或更新对象，请使用 state present 指令。

  • 要删除对象，请使用 state absent 指令。

  • 通常，当返回非零 rc 时，运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 覆盖失败或成功的条件。

示例

- 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>

返回值

常见的返回值已在此处记录 此处，以下是此模块独有的字段

键

描述

meta

字典

请求的结果。

返回: 始终

request_url

字符串

请求的完整 URL。

返回: 始终

示例: "/sys/login/user"

response_code

整数

API 请求的状态。

返回: 始终

示例: 0

response_data

列表 / 元素=字符串

API 响应。

返回: 始终

response_message

字符串

API 响应的描述性消息。

返回: 始终

示例: "OK."

system_information

字典

目标系统的信息。

返回: 始终

rc

整数

请求的状态。

返回: 始终

示例: 0

version_check_warning

列表 / 元素=字符串

如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则发出警告。

返回: 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)