Модуль fortinet.fortios.fortios_telemetry_controller_profile — настройка профилей 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_profile.
Добавлено в fortinet.fortios 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя функцию telemetry_controller и категорию profile. В примерах приведены все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием. Проверено на FOS v6.0.0
Требования
На хосте, где выполняется этот модуль, должны быть установлены следующие компоненты.
- ansible>=2.16
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Аутентификация на основе токена. Токен создается в графическом интерфейсе FortiGate. |
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
member_path string | Путь к атрибуту элемента, над которым выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с пометкой member_path можно использовать для выполнения операции над элементом. |
member_state string | Добавить или удалить элемент по указанному пути к атрибуту. Если задан параметр member_state, параметр state игнорируется. Варианты:
|
state string / обязательный | Определяет, следует ли создать или удалить объект. Варианты:
|
telemetry_controller_profile dictionary | Настройка профилей FortiTelemetry. |
|
application list / элементы=dictionary |
Настройка приложений. |
|
app_name string |
Имя приложения. Источник: telemetry-controller.application.custom.app-name, telemetry-controller.application.predefine.app-name. |
|
id integer / обязательный |
Идентификатор. См. <a href=’#notes’>Примечания</a>. |
|
interval integer |
Интервал проверки приложения в миллисекундах (1000–86 400 * 1000). |
|
monitor string |
Включить или отключить мониторинг приложения. Варианты:
|
|
sla dictionary |
Соглашение об уровне обслуживания (SLA). |
|
app_throughput_threshold integer |
Порог пропускной способности приложения в мегабайтах (0–10 000). |
|
atdt_threshold integer |
Порог общего времени загрузки приложения в миллисекундах (0–10 000 000). |
|
dns_time_threshold integer |
Порог 95-го процентиля времени разрешения DNS в миллисекундах (0–10 000 000). |
|
experience_score_threshold integer |
Порог оценки качества взаимодействия (0–10). |
|
failure_rate_threshold integer |
Порог частоты сбоев (0–100). |
|
jitter_threshold integer |
Порог джиттера в миллисекундах (0–10 000 000). |
|
latency_threshold integer |
Порог задержки в миллисекундах (0–10 000 000). |
|
packet_loss_threshold integer |
Порог потери пакетов (0–100). |
|
sla_factor list / элементы=string |
Критерии, определяющие список пороговых значений SLA для метрик. Варианты:
|
|
tcp_rtt_threshold integer |
Порог времени кругового обмена TCP в миллисекундах (0–10 000 000). |
|
tls_time_threshold integer |
Порог 95-го процентиля времени TLS-рукопожатия в миллисекундах (0–10 000 000). |
|
ttfb_threshold integer |
Порог времени до получения первого байта в миллисекундах (0–10 000 000). |
|
comment string |
Комментарий. |
|
name string / обязательный |
Имя профиля. |
vdom string | Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Устаревший fortiosapi объявлен нерекомендуемым; для запуска плейбуков предпочтительно использовать httpapi
Примеры
- name: Configure FortiTelemetry profiles.
fortinet.fortios.fortios_telemetry_controller_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
telemetry_controller_profile:
application:
-
app_name: "<your_own_value> (source telemetry-controller.application.custom.app-name telemetry-controller.application.predefine.app-name)"
id: "5"
interval: "300000"
monitor: "enable"
sla:
app_throughput_threshold: "2"
atdt_threshold: "3000"
dns_time_threshold: "100"
experience_score_threshold: "6"
failure_rate_threshold: "5"
jitter_threshold: "50"
latency_threshold: "100"
packet_loss_threshold: "5"
sla_factor: "experience-score"
tcp_rtt_threshold: "100"
tls_time_threshold: "200"
ttfb_threshold: "200"
comment: "Comment."
name: "default_name_22"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа FortiGate Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для передачи данных на FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, полученный от FortiGate при выполнении последней операции Возвращается: всегда Пример: |
mkey string | Главный ключ (идентификатор), использованный при последнем обращении к FortiGate Возвращается: при успешном выполнении Пример: |
name string | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер редакции Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Результат операции Возвращается: всегда Пример: |
vdom string | Использованный виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_profile_module.html
