Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_vpnsslweb_portal_bookmarkgroup — группа закладок портала.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortimanager.fmgr_vpnsslweb_portal_bookmarkgroup.

Добавлено в fortinet.fortimanager 2.0.0

  • Краткое описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Этот модуль позволяет настраивать устройство FortiManager.
  • В примерах указаны все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.

Параметры

Параметр

Комментарии

access_token

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

string / обязательный

Параметр (adom) в запрошенном URL.

bypass_validation

boolean

Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager; модуль продолжит выполнение без проверки параметров.

Варианты:

  • false ← (по умолчанию)
  • true

enable_log

boolean

Включить/отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

forticloud_access_token

string

Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.

portal

string / обязательный

Параметр (portal) в запрошенном URL.

proposed_method

string

Переопределённый метод для базового запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

list / elements=integer

Список кодов rc, для которых переопределяются условия сбоя.

rc_succeeded

list / elements=integer

Список кодов rc, для которых переопределяются условия успешного выполнения.

revision_note

string

Примечание об изменении, которое можно указать при создании или обновлении объекта.

state

string / обязательный

Директива для создания, обновления или удаления объекта.

Варианты:

  • "present"
  • "absent"

vpnsslweb_portal_bookmarkgroup

dictionary

Набор параметров верхнего уровня.

bookmarks

list / elements=dictionary

Закладки.

additional_params

псевдонимы: additional-params

string

Дополнительные параметры.

apptype

string

Тип приложения.

Варианты:

  • "web"
  • "telnet"
  • "ssh"
  • "ftp"
  • "smb"
  • "vnc"
  • "rdp"
  • "citrix"
  • "rdpnative"
  • "portforward"
  • "sftp"

color_depth

псевдонимы: color-depth

string

Глубина цвета на пиксель.

Варианты:

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

description

string

Описание.

domain

string

Домен входа.

folder

string

Параметр папки общей сетевой папки.

form_data

псевдонимы: form-data

list / elements=dictionary

Данные формы.

name

string

Имя.

value

string

Значение.

height

integer

Высота экрана

host

string

Параметр имени/IP-адреса узла.

keyboard_layout

псевдонимы: keyboard-layout

string

Раскладка клавиатуры.

Варианты:

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

integer

Порт прослушивания

load_balancing_info

псевдонимы: load-balancing-info

string

Информация о балансировке нагрузки или cookie, которые следует передать брокеру соединений.

logon_password

псевдонимы: logon-password

any

(список) Пароль для входа.

logon_user

псевдонимы: logon-user

string

Пользователь для входа.

name

string

Название закладки.

port

integer

Удалённый порт.

preconnection_blob

псевдонимы: preconnection-blob

string

Произвольная строка, идентифицирующая источник RDP.

preconnection_id

псевдонимы: preconnection-id

integer

Числовой идентификатор источника RDP

remote_port

псевдонимы: remote-port

integer

Удалённый порт

restricted_admin

псевдонимы: restricted-admin

string

Включить/отключить режим ограниченного администрирования для RDP.

Варианты:

  • "disable"
  • "enable"

security

string

Режим безопасности для подключения RDP.

Варианты:

  • "rdp"
  • "nla"
  • "tls"
  • "any"

send_preconnection_id

псевдонимы: send-preconnection-id

string

Включить/отключить отправку идентификатора предварительного подключения.

Варианты:

  • "disable"
  • "enable"

server_layout

псевдонимы: server-layout

string

Раскладка клавиатуры на стороне сервера.

Варианты:

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

string

Включить/отключить отображение окна состояния.

Варианты:

  • "disable"
  • "enable"

sso

string

Единый вход.

Варианты:

  • "disable"
  • "static"
  • "auto"

sso_credential

псевдонимы: sso-credential

string

Учётные данные единого входа.

Варианты:

  • "sslvpn-login"
  • "alternative"

sso_credential_sent_once

псевдонимы: sso-credential-sent-once

string

Учётные данные единого входа отправляются на удалённый сервер только один раз.

Варианты:

  • "disable"
  • "enable"

sso_password

псевдонимы: sso-password

any

(список) Пароль SSO.

sso_username

псевдонимы: sso-username

string

Имя пользователя SSO.

url

string

Параметр URL.

vnc_keyboard_layout

псевдонимы: vnc-keyboard-layout

string

Раскладка клавиатуры.

Варианты:

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

Ширина экрана

name

string / обязательный

Название группы закладок.

workspace_locking_adom

string

ADOM, блокируемый для FortiManager, работающего в режиме рабочей области; в качестве значения можно указать global и другие ADOM, включая root.

workspace_locking_timeout

integer

Максимальное время ожидания освобождения блокировки рабочей области другим пользователем, в секундах.

По умолчанию: 300

Примечания

Примечание

  • Начиная с версии 2.4.0 все входные аргументы именуются в соответствии с соглашением об использовании подчёркиваний (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, но при их использовании будут выдаваться предупреждения об устаревании. Это предупреждение можно отключить, задав deprecation_warnings=False в ansible.cfg.
  • В этом модуле FortiManager поддерживается режим блокировки рабочей области; для этого предназначены параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
  • Как правило, выполнение модуля завершается с ошибкой при возврате ненулевого rc. Условия возникновения ошибки или успешного завершения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
  • Для создания или обновления объекта используйте директиву state present.
  • Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Portal bookmark group.
      fortinet.fortimanager.fmgr_vpnsslweb_portal_bookmarkgroup:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        portal: <your own value>
        state: present # <value in [present, absent]>
        vpnsslweb_portal_bookmarkgroup:
          name: "your value" # Required variable, string
          # 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, ...]>

Возвращаемые значения

Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

meta

dictionary

Результат запроса.

Возвращается: всегда

request_url

string

Полный URL запроса.

Возвращается: всегда

Пример: "/sys/login/user"

response_code

integer

Статус запроса API.

Возвращается: всегда

Пример: 0

response_data

list / elements=string

Ответ API.

Возвращается: всегда

response_message

string

Описание ответа API.

Возвращается: всегда

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

Возвращается: всегда

rc

integer

Статус запроса.

Возвращается: всегда

Пример: 0

version_check_warning

list / elements=string

Предупреждение о том, что используемые в сценарии параметры не поддерживаются текущей версией FortiManager.

Возвращается: при определённых условиях

Авторы

  • Xinwei Du (@dux-fortinet)
  • Xing Li (@lix-fortinet)
  • Jie Xue (@JieX19)
  • Link Zheng (@chillancezen)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

© 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_vpnsslweb_portal_bookmarkgroup_module.html

Spec-Zone.ru

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