Модуль fortinet.fortimanager.fmgr_wanprof_system_sdwan_healthcheckfortiguard_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_healthcheckfortiguard_sla.
Добавлено в fortinet.fortimanager 2.14.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiManager.
- В примерах указаны все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрашиваемом URL. |
bypass_validation boolean | Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
health-check-fortiguard string | Устарел, используйте «health_check_fortiguard» |
health_check_fortiguard string | Параметр (health-check-fortiguard) в запрашиваемом URL. |
proposed_method string | Переопределяемый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / элементы=integer | Список кодов rc, переопределяющий условия неудачного выполнения. |
rc_succeeded list / элементы=integer | Список кодов rc, переопределяющий условия успешного выполнения. |
state string / обязательный | Указание на создание, обновление или удаление объекта. Варианты:
|
wanprof string / обязательный | Параметр (wanprof) в запрашиваемом URL. |
wanprof_system_sdwan_healthcheckfortiguard_sla dictionary | Набор параметров верхнего уровня. |
|
id integer / обязательный |
Идентификатор SLA. |
|
jitter_threshold псевдонимы: jitter-threshold integer |
Порог джиттера в миллисекундах, используемый для принятия решения по SLA. |
|
latency_threshold псевдонимы: latency-threshold integer |
Порог задержки в миллисекундах, используемый для принятия решения по SLA. |
|
link_cost_factor псевдонимы: link-cost-factor list / элементы=string |
Критерии выбора канала. Варианты:
|
|
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 или другой ADOM, включая root. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания снятия блокировки рабочей области другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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_healthcheckfortiguard_sla:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
wanprof: <your own value>
health_check_fortiguard: <your own value>
state: present # <value in [present, absent]>
wanprof_system_sdwan_healthcheckfortiguard_sla:
id: 0 # Required variable, integer
# jitter_threshold: <integer>
# latency_threshold: <integer>
# link_cost_factor: ["latency", "jitter", "packet-loss", "mos", "remote"]
# mos_threshold: <string>
# packetloss_threshold: <integer>
# priority_in_sla: <integer>
# priority_out_sla: <integer>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / элементы=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / элементы=string | Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях |
Ссылки на коллекцию
© 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_healthcheckfortiguard_sla_module.html
