Модуль fortinet.fortimanager.fmgr_vpnsslweb_portal_bookmarkgroup_bookmarks – Таблица закладок.

Примечание

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

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

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

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

Новое в fortinet.fortimanager 2.0.0

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

Описание

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bookmark-group строка	Устарело, используйте «bookmark_group»
bookmark_group строка	Параметр (bookmark-group) в запрошенном 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 строка	Имя.

END_OF_DOCUMENT_MARKER

value string	Значение.
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 / required	Имя закладки.
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. Макет клавиатуры на стороне сервера. Варианты: `"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	Single Sign-On. Варианты: `"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	Ширина экрана
workspace_locking_adom string	ADOM для блокировки рабочего пространства FortiManager в режиме рабочего пространства, значение может быть глобальным и другими, включая 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 помогают в этой работе.
Для создания или обновления объекта используйте директиву 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: Bookmark table.
      fortinet.fortimanager.fmgr_vpnsslweb_portal_bookmarkgroup_bookmarks:
        # 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>
        bookmark_group: <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, ...]>

Значения возврата

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

Ключ	Описание
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_bookmarks_module.html