Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_vpn_ssl_web_user_bookmark — настройка закладки пользователя Agentless VPN в Fortinet FortiOS и FortiGate.

Примечание

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

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

Чтобы установить коллекцию, используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.

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

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

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

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

  • Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функции vpn_ssl_web и категории user_bookmark. В примерах приведены все параметры и значения, которые перед использованием необходимо адаптировать к источникам данных. Проверено на FOS v6.0.0

Требования

На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

Аутентификация на основе токена. Токен создается в графическом интерфейсе FortiGate.

enable_log

boolean

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

Варианты:

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

member_path

string

Путь к атрибуту элемента, над которым выполняется операция.

Если атрибутов несколько, они разделяются символом косой черты.

Параметр member_path можно использовать для выполнения операции над элементом.

member_state

string

Добавить или удалить элемент по указанному пути к атрибуту.

Если задан параметр member_state, параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

state

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

Указывает, следует ли создать или удалить объект.

Варианты:

  • "present"
  • "absent"

vdom

string

Виртуальный домен из числа предварительно определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

По умолчанию: "root"

vpn_ssl_web_user_bookmark

dictionary

Настройка закладки пользователя Agentless VPN.

bookmarks

list / elements=dictionary

Таблица закладок.

additional_params

string

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

apptype

string

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

Варианты:

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

color_depth

string

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

Варианты:

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

description

string

Описание.

domain

string

Домен входа в систему.

folder

string

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

form_data

list / elements=dictionary

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

name

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

Имя.

value

string

Значение.

height

integer

Высота экрана (от 0 до 65535).

host

string

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

keyboard_layout

string

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

Варианты:

  • "ar-101"
  • "ar-102"
  • "ar-102-azerty"
  • "can-mul"
  • "cz"
  • "cz-qwerty"
  • "cz-pr"
  • "da"
  • "nl"
  • "de"
  • "de-ch"
  • "de-ibm"
  • "en-uk"
  • "en-uk-ext"
  • "en-us"
  • "en-us-dvorak"
  • "es"
  • "es-var"
  • "fi"
  • "fi-sami"
  • "fr"
  • "fr-apple"
  • "fr-ca"
  • "fr-ch"
  • "fr-be"
  • "hr"
  • "hu"
  • "hu-101"
  • "it"
  • "it-142"
  • "ja"
  • "ja-106"
  • "ko"
  • "la-am"
  • "lt"
  • "lt-ibm"
  • "lt-std"
  • "lav-std"
  • "lav-leg"
  • "mk"
  • "mk-std"
  • "no"
  • "no-sami"
  • "pol-214"
  • "pol-pr"
  • "pt"
  • "pt-br"
  • "pt-br-abnt2"
  • "ru"
  • "ru-mne"
  • "ru-t"
  • "sl"
  • "sv"
  • "sv-sami"
  • "tuk"
  • "tur-f"
  • "tur-q"
  • "zh-sym-sg-us"
  • "zh-sym-us"
  • "zh-tr-hk"
  • "zh-tr-mo"
  • "zh-tr-us"

listening_port

integer

Порт прослушивания (0–65535).

load_balancing_info

string

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

logon_password

string

Пароль для входа в систему.

logon_user

string

Пользователь для входа в систему.

name

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

Имя закладки.

port

integer

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

preconnection_blob

string

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

preconnection_id

integer

Числовой идентификатор источника RDP (0–4294967295).

remote_port

integer

Удаленный порт (0–65535).

restricted_admin

string

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

Варианты:

  • "enable"
  • "disable"

security

string

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

Варианты:

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

send_preconnection_id

string

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

Варианты:

  • "enable"
  • "disable"

server_layout

string

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

Варианты:

  • "de-de-qwertz"
  • "en-gb-qwerty"
  • "en-us-qwerty"
  • "es-es-qwerty"
  • "fr-ca-qwerty"
  • "fr-fr-azerty"
  • "fr-ch-qwertz"
  • "it-it-qwerty"
  • "ja-jp-qwerty"
  • "pt-br-qwerty"
  • "sv-se-qwerty"
  • "tr-tr-qwerty"
  • "failsafe"

show_status_window

string

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

Варианты:

  • "enable"
  • "disable"

sso

string

Единый вход (SSO).

Варианты:

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

sso_credential

string

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

Варианты:

  • "sslvpn-login"
  • "alternative"

sso_credential_sent_once

string

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

Варианты:

  • "enable"
  • "disable"

sso_password

string

Пароль SSO.

sso_username

string

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

url

string

Параметр URL.

vnc_keyboard_layout

string

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

Варианты:

  • "default"
  • "da"
  • "nl"
  • "en-uk"
  • "en-uk-ext"
  • "fi"
  • "fr"
  • "fr-be"
  • "fr-ca-mul"
  • "de"
  • "de-ch"
  • "it"
  • "it-142"
  • "pt"
  • "pt-br-abnt2"
  • "no"
  • "gd"
  • "es"
  • "sv"
  • "us-intl"

width

integer

Ширина экрана (от 0 до 65535).

custom_lang

string

Пользовательский язык. Источник: system.custom-language.name.

name

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

Имя пользователя и группы.

Примечания

Примечание

  • Устаревший fortiosapi объявлен нерекомендуемым; для запуска плейбуков предпочтительно использовать httpapi.
  • Модуль поддерживает check_mode.

Примеры

- name: Configure Agentless VPN user bookmark.
  fortinet.fortios.fortios_vpn_ssl_web_user_bookmark:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      vpn_ssl_web_user_bookmark:
          bookmarks:
              -
                  additional_params: "<your_own_value>"
                  apptype: "ftp"
                  color_depth: "32"
                  description: "<your_own_value>"
                  domain: "<your_own_value>"
                  folder: "<your_own_value>"
                  form_data:
                      -
                          name: "default_name_11"
                          value: "<your_own_value>"
                  height: "768"
                  host: "myhostname"
                  keyboard_layout: "ar-101"
                  listening_port: "0"
                  load_balancing_info: "<your_own_value>"
                  logon_password: "<your_own_value>"
                  logon_user: "<your_own_value>"
                  name: "default_name_20"
                  port: "0"
                  preconnection_blob: "<your_own_value>"
                  preconnection_id: "2147483648"
                  remote_port: "0"
                  restricted_admin: "enable"
                  security: "any"
                  send_preconnection_id: "enable"
                  server_layout: "de-de-qwertz"
                  show_status_window: "enable"
                  sso: "disable"
                  sso_credential: "sslvpn-login"
                  sso_credential_sent_once: "enable"
                  sso_password: "<your_own_value>"
                  sso_username: "<your_own_value>"
                  url: "myurl.com"
                  vnc_keyboard_layout: "default"
                  width: "1024"
          custom_lang: "<your_own_value> (source system.custom-language.name)"
          name: "default_name_39"

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

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

Ключ

Описание

build

string

Номер сборки образа FortiGate

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

Пример: "1547"

http_method

string

Последний метод, использованный для передачи содержимого в FortiGate

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

Пример: "PUT"

http_status

string

Последний результат, возвращённый FortiGate для последней выполненной операции

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

Пример: "200"

mkey

string

Мастер-ключ (идентификатор), использованный при последнем обращении к FortiGate

Возвращается: при успехе

Пример: "id"

name

string

Имя таблицы, использованной для выполнения запроса

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

Пример: "urlfilter"

path

string

Путь к таблице, использованной для выполнения запроса

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

Пример: "webfilter"

revision

string

Внутренний номер ревизии

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

Пример: "17.0.2.10658"

serial

string

Серийный номер устройства

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

Пример: "FGVMEVYYQT3AB5352"

status

string

Результат операции

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

Пример: "success"

vdom

string

Используемый виртуальный домен

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

Пример: "root"

version

string

Версия FortiGate

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

Пример: "v5.6.3"

Авторы

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

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

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

© 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/fortios/fortios_vpn_ssl_web_user_bookmark_module.html

Spec-Zone.ru

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