Модуль fortinet.fortios.fortios_telemetry_controller_global — настройка глобальных параметров FortiTelemetry в Fortinet FortiOS и FortiGate.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для работы с этим модулем необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_telemetry_controller_global.

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

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

Обзор

Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функции telemetry_controller и категории global. В примерах приведены все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием. Проверено на FOS v6.0.0

Требования

На узле, выполняющем этот модуль, должны быть соблюдены следующие требования.

ansible>=2.16

Параметры

Параметр	Комментарии
access_token строка	Аутентификация на основе токена. Создаётся в графическом интерфейсе Fortigate.
enable_log логическое значение	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path строка	Путь к атрибуту элемента, над которым выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с пометкой member_path предназначен для выполнения операций с элементами.
member_state строка	Добавить или удалить элемент по указанному пути к атрибуту. Если задан параметр member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
telemetry_controller_global словарь	Настройка глобальных параметров FortiTelemetry.
auto_group_telemetry_addr строка	Включить или отключить автоматическое добавление адреса телеметрии в группу адресов по умолчанию TELEMETRY. Варианты: `"enable"` `"disable"`
region строка	Настройка региона облачной телеметрии. Варианты: `"global"`
retry_interval целое число	Настройка интервала повторных попыток подключения к облачной телеметрии (1–999).
telemetry_ca_certificate строка	Имя сертификата CA, используемого для проверки сертификата агента телеметрии. Источник: certificate.ca.name.
vdom строка	Виртуальный домен из числа ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Устаревшая библиотека fortiosapi объявлена устаревшей; для запуска плейбуков рекомендуется использовать httpapi

Примеры

- name: Configure FortiTelemetry global settings.
  fortinet.fortios.fortios_telemetry_controller_global:
      vdom: "{{ vdom }}"
      telemetry_controller_global:
          auto_group_telemetry_addr: "enable"
          region: "global"
          retry_interval: "60"
          telemetry_ca_certificate: "<your_own_value> (source certificate.ca.name)"

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

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

Ключ	Описание
build строка	Номер сборки образа FortiGate Возвращается: всегда Пример: `"1547"`
http_method строка	Последний метод, использованный для передачи данных на FortiGate Возвращается: всегда Пример: `"PUT"`
http_status строка	Последний результат, полученный от FortiGate при выполнении последней операции Возвращается: всегда Пример: `"200"`
mkey строка	Главный ключ (идентификатор), использованный при последнем вызове FortiGate Возвращается: при успешном выполнении Пример: `"id"`
name строка	Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path строка	Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision строка	Внутренний номер редакции Возвращается: всегда Пример: `"17.0.2.10658"`
serial строка	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status строка	Результат выполнения операции Возвращается: всегда Пример: `"success"`
vdom строка	Использованный виртуальный домен Возвращается: всегда Пример: `"root"`
version строка	Версия FortiGate Возвращается: всегда Пример: `"v5.6.3"`

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

Ссылки на коллекцию

© 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/fortios/fortios_telemetry_controller_global_module.html