fortinet.fortimanager.fmgr_vpnsslweb_portal_bookmarkgroup – Группа закладок портала.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_vpnsslweb_portal_bookmarkgroup.
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать для использования данных из источников.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |||
|---|---|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | ||||
| bypass_validation логический тип |
| устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров | |||
| portal строка / обязательно | параметр (portal) в запрошенном URL | ||||
| rc_failed список / элементы=строка | список кодов rc, с которыми условия завершения работы будут переопределены | ||||
| rc_succeeded список / элементы=строка | список кодов rc, с которыми условия успешного завершения работы будут переопределены | ||||
| state строка / обязательно |
| директива для создания, обновления или удаления объекта | |||
| vpnsslweb_portal_bookmarkgroup словарь | параметры верхнего уровня | ||||
| bookmarks список / элементы=строка | нет описания | ||||
| additional-params строка | Дополнительные параметры. | ||||
| apptype строка |
| Тип приложения. | |||
| description строка | Описание. | ||||
| folder строка | Параметр сетевой общей папки. | ||||
| form-data список / элементы=строка | нет описания | ||||
| name строка | Имя. | ||||
| value строка | Значение. | ||||
| host строка | Имя хоста/IP-адрес. | ||||
| listening-port целое число | Порт прослушивания (0-65535). | ||||
| load-balancing-info строка | Информация о балансировке нагрузки или cookie, которые должны быть предоставлены брокеру соединений. | ||||
| logon-password строка | нет описания | ||||
| logon-user строка | Имя пользователя для входа. | ||||
| name строка | Имя закладки. | ||||
| port целое число | Удаленный порт. | ||||
| preconnection-blob строка | Произвольная строка, которая идентифицирует источник RDP. | ||||
| preconnection-id целое число | Числовой идентификатор источника RDP (0-2147483648). | ||||
| remote-port целое число | Удаленный порт (0-65535). | ||||
| security строка |
| Режим безопасности для RDP-соединения. | |||
| server-layout строка |
| Макет клавиатуры сервера. | |||
| show-status-window строка |
| Включение/выключение отображения окна состояния. | |||
| sso строка |
| Single Sign-On. | |||
| sso-credential строка |
| Удостоверения Single sign-on. | |||
| sso-credential-sent-once строка |
| Удостоверения Single sign-on отправляются на удаленный сервер только один раз. | |||
| sso-password строка | нет описания | ||||
| sso-username строка | Имя пользователя SSO. | ||||
| url строка | Параметр URL. | ||||
| name строка | Имя группы закладок. | ||||
| workspace_locking_adom строка | adom для блокировки в режиме работы в рабочей области FortiManager, значение может быть глобальным и другими, включая root | ||||
| workspace_locking_timeout целое число | Значение по умолчанию: 300 | максимальное время в секундах ожидания, пока другой пользователь не освободит блокировку рабочей области | |||
Примечания
Примечание
- Поддержка работы в режиме блокировки рабочей области реализована в этом модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно, выполнение одного модуля может завершиться ошибкой при возвращении ненулевого кода rc. Вы также можете переопределить условия завершения работы с ошибкой или успешно с параметрами rc_failed и rc_succeeded.
Примеры
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Portal bookmark group.
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: <value in [present, absent]>
vpnsslweb_portal_bookmarkgroup:
bookmarks:
-
additional-params: <value of string>
apptype: <value in [web, telnet, ssh, ...]>
description: <value of string>
folder: <value of string>
form-data:
-
name: <value of string>
value: <value of string>
host: <value of string>
listening-port: <value of integer>
load-balancing-info: <value of string>
logon-password: <value of string>
logon-user: <value of string>
name: <value of string>
port: <value of integer>
preconnection-blob: <value of string>
preconnection-id: <value of integer>
remote-port: <value of 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: <value of string>
sso-username: <value of string>
url: <value of string>
name: <value of string>
Возвращаемые значения
Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| request_url string | всегда | Полный URL запроса Пример: /sys/login/user |
| response_code integer | всегда | Статус запроса API |
| response_message string | всегда | Дескриптивное сообщение ответа API Пример: OK. |
Авторы
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_vpnsslweb_portal_bookmarkgroup_module.html
