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

Примечание

Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation логическое значение	Устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager. Модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое значение	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать Ansible-клиент с помощью токена доступа к API forticloud.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, по которым условия сбоя будут переопределены.
rc_succeeded список / элементы=целое число	Список кодов rc, по которым условия успеха будут переопределены.
system_connector словарь	Установленные параметры верхнего уровня.
cloud-orchest-refresh-interval целое число	Устаревшее значение, замените на cloud_orchest_refresh_interval. Интервал обновления облачной оркестрации
conn-refresh-interval целое число	Устаревшее значение, замените на conn_refresh_interval. Интервал обновления коннектора
faznotify-msg-queue-max целое число	Устаревшее значение, замените на faznotify_msg_queue_max. Максимальное количество сообщений в очереди faznotify на коннектор
faznotify-msg-timeout целое число	Устаревшее значение, замените на faznotify_msg_timeout. Таймаут сообщения faznotify
fsso-refresh-interval целое число	Устаревшее значение, замените на fsso_refresh_interval. Интервал обновления FSSO
fsso-sess-timeout целое число	Устаревшее значение, замените на fsso_sess_timeout. Таймаут сессии FSSO
px-refresh-interval целое число	Устаревшее значение, замените на px_refresh_interval. Интервал обновления PxGrid
px-svr-timeout целое число	Устаревшее значение, замените на px_svr_timeout. Таймаут сервера PxGrid
workspace_locking_adom строка	ADOM для блокировки FortiManager, работающего в режиме рабочей области. Значение может быть глобальным и другими, включая корень.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочую область. По умолчанию: `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
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure connector.
      fortinet.fortimanager.fmgr_system_connector:
        # 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, ...]
        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>

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

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

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