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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в значение True только при расхождении схемы модуля со структурой API FortiManager, модуль продолжает выполнение без валидации параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Аутентифицировать Ansible-клиент с токеном доступа к API forticloud.
portal строка / обязательно	Параметр (portal) в запрошенном URL.
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 строка	Значение.

END_OF_DOCUMENT_MARKER

height integer	Высота экрана
host string	Имя хоста/IP-параметр.
keyboard-layout string	Устарело, переименуйте в keyboard_layout. Раскладка клавиатуры. Choices: `"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 integer	Устарело, переименуйте в listening_port. Порт прослушивания
load-balancing-info string	Устарело, переименуйте в load_balancing_info. Информация о балансировке нагрузки или cookie, которые должны быть предоставлены…
logon-password any	(list) Устарело, переименуйте в logon_password. Пароль для входа.
logon-user string	Устарело, переименуйте в logon_user. Пользователь для входа.
name string	Имя закладки.
port integer	Удаленный порт.
preconnection-blob string	Устарело, переименуйте в preconnection_blob. Произвольная строка, которая идентифицирует источник RDP.
preconnection-id integer	Устарело, переименуйте в preconnection_id. Числовой ID источника RDP
remote-port integer	Устарело, переименуйте в remote_port. Удаленный порт
restricted-admin string	Устарело, переименуйте в restricted_admin. Включить/отключить режим ограниченного администратора для RDP. Choices: `"disable"` `"enable"`
security string	Режим безопасности для RDP соединения. Choices: `"rdp"` `"nla"` `"tls"` `"any"`
send-preconnection-id string	Устарело, переименуйте в send_preconnection_id. Включить/отключить отправку ID предварительного соединения. Choices: `"disable"` `"enable"`
server-layout string	Устарело, переименуйте в server_layout. Раскладка клавиатуры на стороне сервера. Choices: `"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 string	Устарело, пожалуйста, переименуйте его в show_status_window. Включить/выключить отображение окна состояния. Варианты: `"disable"` `"enable"`
sso string	Одноранговый вход. Варианты: `"disable"` `"static"` `"auto"`
sso-credential string	Устарело, пожалуйста, переименуйте его в sso_credential. Учетные данные однорангового входа. Варианты: `"sslvpn-login"` `"alternative"`
sso-credential-sent-once string	Устарело, пожалуйста, переименуйте его в sso_credential_sent_once. Учетные данные однорангового входа отправляются на удаленный … Варианты: `"disable"` `"enable"`
sso-password any	(список) Устарело, пожалуйста, переименуйте его в sso_password. Пароль SSO.
sso-username string	Устарело, пожалуйста, переименуйте его в sso_username. Имя пользователя SSO.
url string	Параметр URL.
vnc-keyboard-layout string	Устарело, пожалуйста, переименуйте его в 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 integer	Ширина экрана
name string / обязательно	Имя группы закладок.
workspace_locking_adom string	ADOM для блокировки рабочего пространства для FortiManager, работающего в режиме рабочего пространства, значение может быть глобальным и другими, включая корень.
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 помогают выполнить эту работу.
Для создания или обновления объекта используйте директиву 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 список / элементы=строка	Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_vpnsslweb_portal_bookmarkgroup_module.html