Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_ztna_webportalbookmark — настройка закладки веб-портала ZTNA.

Примечание

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

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

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

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

Добавлено в fortinet.fortimanager 2.12.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.

proposed_method

string

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

Варианты:

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

rc_failed

list / элементы=integer

Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным.

rc_succeeded

list / элементы=integer

Список кодов rc, переопределяющий условия, при которых выполнение считается успешным.

revision_note

string

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

state

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

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

Варианты:

  • "present"
  • "absent"

workspace_locking_adom

string

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

workspace_locking_timeout

integer

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

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

ztna_webportalbookmark

dictionary

Параметры верхнего уровня.

bookmarks

list / элементы=dictionary

Закладки.

apptype

string

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

Варианты:

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

color_depth

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

string

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

Варианты:

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

description

string

Описание.

domain

string

Домен для входа.

folder

string

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

height

integer

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

host

string

Параметр имени хоста/IP-адреса.

keyboard_layout

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

string

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

Варианты:

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

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

string

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

logon_password

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

list / элементы=string

Пароль для входа.

logon_user

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

string

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

name

string

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

port

integer

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

preconnection_blob

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

string

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

preconnection_id

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

integer

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

restricted_admin

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

string

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

Варианты:

  • "disable"
  • "enable"

security

string

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

Варианты:

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

send_preconnection_id

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

string

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

Варианты:

  • "disable"
  • "enable"

sso

string

Единый вход.

Варианты:

  • "disable"
  • "enable"

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

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

groups

list / элементы=string

Группы пользователей.

llm_secure_proxy

псевдонимы: llm-secure-proxy

dictionary

Защищённый прокси-сервер LLM.

all_llm_servers

псевдонимы: all-llm-servers

string

Все серверы LLM.

Варианты:

  • "disable"
  • "enable"

llm_servers

псевдонимы: llm-servers

list / элементы=string

Серверы LLM.

name

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

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

type

string

Тип.

Варианты:

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

users

list / элементы=string

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

Примечания

Примечание

  • Начиная с версии 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: 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>

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

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

Ключ

Описание

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

список / элементы=строка

Предупреждение, если используемые в сценарии параметры не поддерживаются текущей версией 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_ztna_webportalbookmark_module.html

Spec-Zone.ru

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