Модуль fortinet.fortimanager.fmgr_telemetrycontroller_profile_application — настройка приложений.

Примечание

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

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

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

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

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

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

Обзор

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation логический	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логический	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
profile строка / обязательный	Параметр (profile) в запрошенном URL.
proposed_method строка	Переопределяемый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы — целые числа	Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным.
rc_succeeded список / элементы — целые числа	Список кодов rc, переопределяющий условия, при которых выполнение считается успешным.
revision_note строка	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state строка / обязательный	Указание на создание, обновление или удаление объекта. Варианты: `"present"` `"absent"`
telemetrycontroller_profile_application словарь	Набор параметров верхнего уровня.
app_name псевдонимы: app-name список / элементы — строки	Имя приложения.
app_throughput псевдонимы: app-throughput целое число	Пропускная способность приложения в мегабайтах
atdt_threshold псевдонимы: atdt-threshold целое число	Пороговое значение общего времени загрузки приложения в миллисекундах
dns_time_threshold псевдонимы: dns-time-threshold целое число	Пороговое значение времени разрешения DNS в миллисекундах
experience_score_threshold псевдонимы: experience-score-threshold целое число	Пороговое значение оценки качества работы
failure_rate_threshold псевдонимы: failure-rate-threshold целое число	Пороговое значение частоты сбоев
id целое число / обязательный	Идентификатор.
interval целое число	Интервал проверки приложения в миллисекундах
jitter_threshold псевдонимы: jitter-threshold целое число	Пороговое значение джиттера в миллисекундах
latency_threshold псевдонимы: latency-threshold целое число	Пороговое значение задержки в миллисекундах
monitor строка	Включить или отключить мониторинг приложения. Варианты: `"disable"` `"enable"`
packet_loss_threshold псевдонимы: packet-loss-threshold целое число	Пороговое значение потери пакетов
sla словарь	SLA.
app_throughput_threshold псевдонимы: app-throughput-threshold целое число	Пороговое значение пропускной способности приложения в мегабайтах
atdt_threshold псевдонимы: atdt-threshold целое число	Пороговое значение общего времени загрузки приложения в миллисекундах
dns_time_threshold псевдонимы: dns-time-threshold целое число	Пороговое значение 95-го процентиля времени разрешения DNS в миллисекундах
experience_score_threshold псевдонимы: experience-score-threshold целое число	Пороговое значение оценки качества работы
failure_rate_threshold псевдонимы: failure-rate-threshold целое число	Пороговое значение частоты сбоев
jitter_threshold псевдонимы: jitter-threshold целое число	Пороговое значение джиттера в миллисекундах
latency_threshold псевдонимы: latency-threshold целое число	Пороговое значение задержки в миллисекундах
packet_loss_threshold псевдонимы: packet-loss-threshold целое число	Пороговое значение потери пакетов
sla_factor псевдонимы: sla-factor список / элементы — строки	Критерии выбора метрики для списка пороговых значений 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 целое число	Пороговое значение времени кругового обмена TCP в миллисекундах
tls_time_threshold псевдонимы: tls-time-threshold целое число	Пороговое значение 95-го процентиля времени TLS-рукопожатия в миллисекундах
ttfb_threshold псевдонимы: ttfb-threshold целое число	Пороговое значение времени до получения первого байта в миллисекундах
tcp_rtt_threshold псевдонимы: tcp-rtt-threshold целое число	Пороговое значение времени кругового обмена TCP в миллисекундах
tls_time_threshold псевдонимы: tls-time-threshold целое число	Пороговое значение времени TLS-рукопожатия в миллисекундах
ttfb_threshold псевдонимы: ttfb-threshold целое число	Пороговое значение времени до получения первого байта в миллисекундах
workspace_locking_adom строка	ADOM, блокируемый для FortiManager, работающего в режиме рабочей области. Значением может быть global или другие ADOM, включая root.
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.
Чтобы создать или обновить объект, используйте директиву state present.
Чтобы удалить объект, используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure applications.
      fortinet.fortimanager.fmgr_telemetrycontroller_profile_application:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        profile: <your own value>
        state: present # <value in [present, absent]>
        telemetrycontroller_profile_application:
          id: 0 # Required variable, integer
          # app_name: <list or string>
          # app_throughput: <integer>
          # atdt_threshold: <integer>
          # dns_time_threshold: <integer>
          # experience_score_threshold: <integer>
          # failure_rate_threshold: <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>

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

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

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