Spec-Zone.ru › Ansible

модуль fortinet.fortios.fortios_telemetry_controller_agent_profile — настройка профилей агентов FortiTelemetry в FortiOS и FortiGate от Fortinet.

Примечание

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

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

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

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

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

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

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

  • Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функции telemetry_controller и категории agent_profile. Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием. Тестировался с 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"

state

строка / обязательный

Указывает, нужно ли создать или удалить объект.

Варианты:

  • "present"
  • "absent"

telemetry_controller_agent_profile

словарь

Настройка профилей агентов FortiTelemetry.

comment

строка

Комментарий.

model

строка

Модель.

Варианты:

  • "ftl-100g"
  • "windows"
  • "macos"
  • "FTL100G"
  • "WINDOWS"

name

строка / обязательный

Имя профиля агента.

vdom

строка

Виртуальный домен из числа ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

По умолчанию: "root"

Примечания

Примечание

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

Примеры

- name: Configure FortiTelemetry agent profiles.
  fortinet.fortios.fortios_telemetry_controller_agent_profile:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      telemetry_controller_agent_profile:
          comment: "Comment."
          model: "ftl-100g"
          name: "default_name_5"

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

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

Ключ

Описание

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_agent_profile_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API