Модуль fortinet.fortimanager.fmgr_wanprof_system_sdwan_healthcheck_sla — соглашение об уровне обслуживания

Примечание

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

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

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

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

Добавлено в fortinet.fortimanager 2.1.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.
health-check string	Устарел; используйте «health_check»
health_check string	Параметр (health-check) в запрашиваемом URL.
proposed_method string	Метод, переопределяющий метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным.
rc_succeeded list / элементы=integer	Список кодов rc, переопределяющий условия, при которых выполнение считается успешным.
state string / обязательный	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
wanprof string / обязательный	Параметр (wanprof) в запрашиваемом URL.
wanprof_system_sdwan_healthcheck_sla dictionary	Набор параметров верхнего уровня.
custom_profile_threshold псевдонимы: custom-profile-threshold integer	Пороговое значение пользовательского профиля, при котором SLA считается выполненным.
id integer / обязательный	Идентификатор SLA.
jitter_threshold псевдонимы: jitter-threshold integer	Допустимый джиттер для принятия решения по SLA, в миллисекундах.
latency_threshold псевдонимы: latency-threshold integer	Допустимая задержка для принятия решения по SLA, в миллисекундах.
link_cost_factor псевдонимы: link-cost-factor list / элементы=string	Критерии, на основе которых выбирается канал связи. Варианты: `"latency"` `"jitter"` `"packet-loss"` `"mos"` `"remote"` `"custom-profile-1"`
mos_threshold псевдонимы: mos-threshold string	Минимальная средняя оценка качества (MOS), при которой SLA считается выполненным.
packetloss_threshold псевдонимы: packetloss-threshold integer	Допустимая потеря пакетов для принятия решения по SLA, в процентах.
priority_in_sla псевдонимы: priority-in-sla integer	Значение, добавляемое в таблицу маршрутизации при соблюдении SLA.
priority_out_sla псевдонимы: priority-out-sla integer	Значение, добавляемое в таблицу маршрутизации при несоблюдении SLA.
workspace_locking_adom string	ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другое значение, включая 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: Service level agreement
      fortinet.fortimanager.fmgr_wanprof_system_sdwan_healthcheck_sla:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        wanprof: <your own value>
        health_check: <your own value>
        state: present # <value in [present, absent]>
        wanprof_system_sdwan_healthcheck_sla:
          id: 0 # Required variable, integer
          # jitter_threshold: <integer>
          # latency_threshold: <integer>
          # link_cost_factor: ["latency", "jitter", "packet-loss", "mos", "remote",
          #                    "custom-profile-1"]
          # packetloss_threshold: <integer>
          # mos_threshold: <string>
          # priority_in_sla: <integer>
          # priority_out_sla: <integer>
          # custom_profile_threshold: <integer>

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

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

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