Модуль fortinet.fortimanager.fmgr_system_connector — настройка коннектора.

Примечание

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

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

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

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

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

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

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

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
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, с помощью которого переопределяются условия успешного выполнения.
system_connector dictionary	Набор параметров верхнего уровня.
cloud_orchest_refresh_interval псевдонимы: cloud-orchest-refresh-interval integer	Интервал обновления Cloud Orchestration
conn_refresh_interval псевдонимы: conn-refresh-interval integer	Интервал обновления коннектора
conn_ssl_protocol псевдонимы: conn-ssl-protocol string	Установить минимальную версию протокола SSL для коннектора. follow-global-ssl-protocol — следовать настройкам системы. sslv3 — установить SSLv3 в качестве минимальной версии. tlsv1. tlsv1. tlsv1. tlsv1. Варианты: `"follow-global-ssl-protocol"` `"sslv3"` `"tlsv1.0"` `"tlsv1.1"` `"tlsv1.2"` `"tlsv1.3"`
faznotify_msg_queue_max псевдонимы: faznotify-msg-queue-max integer	Максимальное количество сообщений Faznotify в очереди для одного коннектора
faznotify_msg_timeout псевдонимы: faznotify-msg-timeout integer	Тайм-аут сообщения Faznotify
fsso_refresh_interval псевдонимы: fsso-refresh-interval integer	Интервал обновления FSSO
fsso_sess_timeout псевдонимы: fsso-sess-timeout integer	Тайм-аут сеанса FSSO
px_refresh_interval псевдонимы: px-refresh-interval integer	Интервал обновления PxGrid
px_svr_timeout псевдонимы: px-svr-timeout integer	Тайм-аут сервера PxGrid
workspace_locking_adom string	ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другое имя, в том числе 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 помогают управлять этим режимом.
Обычно выполнение модуля завершается ошибкой при возврате ненулевого rc. Условия неудачного или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure connector.
      fortinet.fortimanager.fmgr_system_connector:
        # workspace_locking_adom: <global or your adom name>
        system_connector:
          # fsso_refresh_interval: <integer>
          # fsso_sess_timeout: <integer>
          # px_refresh_interval: <integer>
          # px_svr_timeout: <integer>
          # conn_refresh_interval: <integer>
          # cloud_orchest_refresh_interval: <integer>
          # faznotify_msg_queue_max: <integer>
          # faznotify_msg_timeout: <integer>
          # conn_ssl_protocol: <value in [follow-global-ssl-protocol, sslv3, tlsv1.0, ...]>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / элементы=string	Ответ API. Возвращается: всегда
response_message string	Текстовое описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / элементы=string	Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией 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_system_connector_module.html