fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_healthcheck – Проверка состояния или работоспособности SD-WAN. Определите сервер в Интернете и определите, как SD-WAN проверяет, что FortiGate может подключаться к…
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в playbook, укажите: fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_healthcheck.
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать для использования с источниками данных.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | |||
| bypass_validation булево |
| устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров | ||
| rc_failed список / элементы=строка | список кодов rc, при которых условия будут нарушены | |||
| rc_succeeded список / элементы=строка | список кодов rc, при которых условия будут соблюдены | |||
| state строка / обязательно |
| направление для создания, обновления или удаления объекта | ||
| wanprof строка / обязательно | параметр (wanprof) в запрошенном URL | |||
| wanprof_system_virtualwanlink_healthcheck словарь | настроенные параметры верхнего уровня | |||
| _dynamic-server строка | нет описания | |||
| addr-mode строка |
| Режим адреса (IPv4 или IPv6). | ||
| failtime целое число | Количество неудач перед тем, как сервер считается потерянным (1-3600, по умолчанию = 5). | |||
| http-agent строка | Строка в поле http-agent в заголовке HTTP. | |||
| http-get строка | URL, используемый для связи с сервером, если протокол HTTP. | |||
| http-match строка | Ожидаемая строка ответа от сервера, если протокол HTTP. | |||
| interval целое число | Интервал проверки состояния, или время между попытками подключения к серверу (1-3600 сек, по умолчанию = 5). | |||
| members строка | Список номеров последовательности членов. | |||
| name строка | Название проверки состояния или работоспособности. | |||
| packet-size целое число | Размер пакета сеанса тестирования twamp. | |||
| password строка | нет описания | |||
| port целое число | Номер порта, используемый для связи с сервером по выбранному протоколу. | |||
| protocol строка |
| Протокол, используемый для определения возможности связи FortiGate с сервером. | ||
| recoverytime целое число | Количество полученных успешных ответов перед тем, как сервер считается восстановленным (1-3600, по умолчанию = 5). | |||
| security-mode строка |
| Режим безопасности контроллера Twamp. | ||
| server строка | нет описания | |||
| sla список / элементы=строка | нет описания | |||
| id целое число | ID SLA. | |||
| jitter-threshold целое число | Джиттер для принятия решения SLA в миллисекундах (0-10000000, по умолчанию = 5). | |||
| latency-threshold целое число | Задержка для принятия решения SLA в миллисекундах (0-10000000, по умолчанию = 5). | |||
| link-cost-factor список / элементы=строка |
| нет описания | ||
| packetloss-threshold целое число | Потеря пакетов для принятия решения SLA в процентах (0-100, по умолчанию = 0). | |||
| threshold-alert-jitter целое число | Пороговое значение уведомления для джиттера (мс, по умолчанию = 0). | |||
| threshold-alert-latency целое число | Пороговое значение уведомления для задержки (мс, по умолчанию = 0). | |||
| threshold-alert-packetloss целое число | Пороговое значение уведомления для потери пакетов (проценты, по умолчанию = 0). | |||
| threshold-warning-jitter целое число | Пороговое значение предупреждения для джиттера (мс, по умолчанию = 0). | |||
| threshold-warning-latency целое число | Пороговое значение предупреждения для задержки (мс, по умолчанию = 0). | |||
| threshold-warning-packetloss целое число | Пороговое значение предупреждения для потери пакетов (проценты, по умолчанию = 0). | |||
| update-cascade-interface строка |
| Включить/выключить обновление интерфейса каскада. | ||
| update-static-route строка |
| Включить/выключить обновление статического маршрута. | ||
| workspace_locking_adom строка | домен для блокировки FortiManager, работающего в режиме рабочей зоны; значение может быть глобальным и другими, включая корневой | |||
| workspace_locking_timeout целое число | По умолчанию: 300 | максимальное время в секундах ожидания, пока другой пользователь не освободит блокировку рабочей зоны | ||
Примечания
Примечание
- Работа в режиме блокировки рабочей зоны поддерживается в этом модуле FortiManager; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно выполнение одного модуля может завершиться неудачей, если возвращается ненулевой rc. Вы также можете переопределить условия неудачи или успеха параметрами rc_failed и rc_succeeded
Примеры
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: SD-WAN status checking or health checking. Identify a server on the Internet and determine how SD-WAN verifies that the FortiGate can co...
fmgr_wanprof_system_virtualwanlink_healthcheck:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
wanprof: <your own value>
state: <value in [present, absent]>
wanprof_system_virtualwanlink_healthcheck:
_dynamic-server: <value of string>
addr-mode: <value in [ipv4, ipv6]>
failtime: <value of integer>
http-agent: <value of string>
http-get: <value of string>
http-match: <value of string>
interval: <value of integer>
members: <value of string>
name: <value of string>
packet-size: <value of integer>
password: <value of string>
port: <value of integer>
protocol: <value in [ping, tcp-echo, udp-echo, ...]>
recoverytime: <value of integer>
security-mode: <value in [none, authentication]>
server: <value of string>
sla:
-
id: <value of integer>
jitter-threshold: <value of integer>
latency-threshold: <value of integer>
link-cost-factor:
- latency
- jitter
- packet-loss
packetloss-threshold: <value of integer>
threshold-alert-jitter: <value of integer>
threshold-alert-latency: <value of integer>
threshold-alert-packetloss: <value of integer>
threshold-warning-jitter: <value of integer>
threshold-warning-latency: <value of integer>
threshold-warning-packetloss: <value of integer>
update-cascade-interface: <value in [disable, enable]>
update-static-route: <value in [disable, enable]>
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| request_url string | всегда | Полный URL запроса Пример: /sys/login/user |
| response_code integer | всегда | Статус запроса API |
| response_message string | всегда | Дескриптивное сообщение ответа API Пример: OK. |
Авторы
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_wanprof_system_virtualwanlink_healthcheck_module.html
