модуль fortinet.fortimanager.fmgr_telemetrycontroller_profile – настройка профилей FortiTelemetry.

Примечание

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

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

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

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

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

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

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

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрашиваемом URL.
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, переопределяющий условия успешного завершения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Указание на создание, обновление или удаление объекта. Варианты: `"present"` `"absent"`
telemetrycontroller_profile dictionary	Набор параметров верхнего уровня.
application list / элементы=dictionary	Приложение.
app_name псевдонимы: app-name list / элементы=string	Название приложения.
app_throughput псевдонимы: app-throughput integer	Пропускная способность приложения в мегабайтах
atdt_threshold псевдонимы: atdt-threshold integer	Пороговое значение общего времени загрузки приложения в миллисекундах
dns_time_threshold псевдонимы: dns-time-threshold integer	Пороговое значение времени разрешения DNS в миллисекундах
experience_score_threshold псевдонимы: experience-score-threshold integer	Пороговое значение оценки качества пользовательского опыта
failure_rate_threshold псевдонимы: failure-rate-threshold integer	Пороговое значение частоты сбоев
id integer	Идентификатор.
interval integer	Интервал проверки приложения в миллисекундах
jitter_threshold псевдонимы: jitter-threshold integer	Пороговое значение джиттера в миллисекундах
latency_threshold псевдонимы: latency-threshold integer	Пороговое значение задержки в миллисекундах
monitor string	Включить или отключить мониторинг приложения. Варианты: `"disable"` `"enable"`
packet_loss_threshold псевдонимы: packet-loss-threshold integer	Пороговое значение потери пакетов
sla dictionary	SLA.
app_throughput_threshold псевдонимы: app-throughput-threshold integer	Пороговое значение пропускной способности приложения в мегабайтах
atdt_threshold псевдонимы: atdt-threshold integer	Пороговое значение общего времени загрузки приложения в миллисекундах
dns_time_threshold псевдонимы: dns-time-threshold integer	Пороговое значение 95-го процентиля времени разрешения DNS в миллисекундах
experience_score_threshold псевдонимы: experience-score-threshold integer	Пороговое значение оценки качества пользовательского опыта
failure_rate_threshold псевдонимы: failure-rate-threshold integer	Пороговое значение частоты сбоев
jitter_threshold псевдонимы: jitter-threshold integer	Пороговое значение джиттера в миллисекундах
latency_threshold псевдонимы: latency-threshold integer	Пороговое значение задержки в миллисекундах
packet_loss_threshold псевдонимы: packet-loss-threshold integer	Пороговое значение потери пакетов
sla_factor псевдонимы: sla-factor list / элементы=string	Критерии выбора метрики для списка пороговых значений SLA. Варианты: `"latency"` `"jitter"` `"packet-loss"` `"experience-score"` `"failure-rate"` `"ttfb"` `"atdt"` `"tcp-rtt"` `"dns-time"` `"tls-time"` `"app-throughput"`
tcp_rtt_threshold псевдонимы: tcp-rtt-threshold integer	Пороговое значение времени кругового обхода TCP в миллисекундах
tls_time_threshold псевдонимы: tls-time-threshold integer	Пороговое значение 95-го процентиля времени TLS-рукопожатия в миллисекундах
ttfb_threshold псевдонимы: ttfb-threshold integer	Пороговое значение времени до получения первого байта в миллисекундах
tcp_rtt_threshold псевдонимы: tcp-rtt-threshold integer	Пороговое значение времени кругового обхода TCP в миллисекундах
tls_time_threshold псевдонимы: tls-time-threshold integer	Пороговое значение времени TLS-рукопожатия в миллисекундах
ttfb_threshold псевдонимы: ttfb-threshold integer	Пороговое значение времени до получения первого байта в миллисекундах
comment string	Комментарий.
name string / обязательный	Имя профиля.
workspace_locking_adom string	ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другие ADOM, включая 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.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure FortiTelemetry profiles.
      fortinet.fortimanager.fmgr_telemetrycontroller_profile:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        telemetrycontroller_profile:
          name: "your value" # Required variable, string
          # application:
          #   - app_name: <list or string>
          #     app_throughput: <integer>
          #     atdt_threshold: <integer>
          #     dns_time_threshold: <integer>
          #     experience_score_threshold: <integer>
          #     failure_rate_threshold: <integer>
          #     id: <integer>
          #     interval: <integer>
          #     jitter_threshold: <integer>
          #     latency_threshold: <integer>
          #     monitor: <value in [disable, enable]>
          #     packet_loss_threshold: <integer>
          #     sla:
          #       app_throughput_threshold: <integer>
          #       atdt_threshold: <integer>
          #       dns_time_threshold: <integer>
          #       experience_score_threshold: <integer>
          #       failure_rate_threshold: <integer>
          #       jitter_threshold: <integer>
          #       latency_threshold: <integer>
          #       packet_loss_threshold: <integer>
          #       sla_factor: ["latency", "jitter", "packet-loss", "experience-score",
          #                    "failure-rate", "ttfb", "atdt", "tcp-rtt", "dns-time", "tls-time",
          #                    "app-throughput"]
          #       tcp_rtt_threshold: <integer>
          #       tls_time_threshold: <integer>
          #       ttfb_threshold: <integer>
          #     tcp_rtt_threshold: <integer>
          #     tls_time_threshold: <integer>
          #     ttfb_threshold: <integer>
          # comment: <string>

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

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

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