fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_healthcheck модуль — проверка состояния SD-WAN или проверка работоспособности.

Примечание

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

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

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

Для использования в playbook укажите: fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_healthcheck.

Впервые в fortinet.fortimanager 2.0.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.
proposed_method строка	Переопределенный метод для основного запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое	Список rc-кодов, с которыми будут переопределены условия сбоя.
rc_succeeded список / элементы=целое	Список rc-кодов, с которыми будут переопределены условия успеха.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
wanprof строка / обязательно	Параметр (wanprof) в запрошенном URL.
wanprof_system_virtualwanlink_healthcheck словарь	Настройка параметров верхнего уровня.
_dynamic-server строка	Устарело, пожалуйста, переименуйте на _dynamic_server. Динамический сервер.
addr-mode строка	Устарело, пожалуйста, переименуйте на addr_mode. Режим адресации Варианты: `"ipv4"` `"ipv6"`
diffservcode строка	Код точки дифференцированных сервисов
dns_request_domain строка	Полное доменное имя для разрешения DNS-зондирования.
failtime целое	Количество сбоев перед тем, как сервер будет считаться потерянным
ha_priority целое	Приоритет выбора HA
http_agent строка	Строка в поле http-agent в HTTP-заголовке.
http_get строка	URL, используемый для связи с сервером, если протокол HTTP.
http_match строка	Ожидаемая строка ответа от сервера, если протокол HTTP.

END_OF_DOCUMENT_MARKER

internet-service-id string	Устарело, переименуйте в internet_service_id. Идентификатор интернет-сервиса.
interval integer	Интервал проверки состояния или время между попытками подключения к серверу
members any	(список или строка) Список номеров последовательности участников.
name string / required	Имя проверки состояния или проверки работоспособности.
packet-size integer	Устарело, переименуйте в packet_size. Размер пакета сеанса тестирования TWAMP,
password any	(список) Пароль контроллера TWAMP в режиме аутентификации
port integer	Номер порта, используемый для связи с сервером по выбранному протоколу.
probe-count integer	Устарело, переименуйте в probe_count. Количество последних проб, которые должны использоваться для вычисления задержки и джиттера
probe-packets string	Устарело, переименуйте в probe_packets. Включить/отключить передачу пробных пакетов. Варианты: `"disable"` `"enable"`
probe-timeout integer	Устарело, переименуйте в probe_timeout. Время ожидания, прежде чем пробный пакет будет считаться потерянным
protocol string	Протокол, используемый для определения того, может ли FortiGate взаимодействовать с сервером. Варианты: `"ping"` `"tcp-echo"` `"udp-echo"` `"http"` `"twamp"` `"ping6"` `"dns"`
recoverytime integer	Количество полученных успешных ответов, прежде чем сервер будет считаться восстановленным
security-mode string	Устарело, переименуйте в security_mode. Режим безопасности контроллера TWAMP. Варианты: `"none"` `"authentication"`
server any	(список) IP-адрес или полное доменное имя сервера.
sla list / elements=dictionary	SLA.
id integer	Идентификатор SLA.
jitter-threshold integer	Устарело, переименуйте в jitter_threshold. Джиттер для SLA для принятия решения в миллисекундах.
latency-threshold integer	Устарело, переименуйте в latency_threshold. Задержка для SLA для принятия решения в миллисекундах.
link-cost-factor list / elements=string	Устарело, переименуйте в link_cost_factor. Критерии, на основе которых должен производиться выбор канала связи. Варианты: `"latency"` `"jitter"` `"packet-loss"`
packetloss-threshold integer	Устарело, переименуйте в packetloss_threshold. Потеря пакетов для SLA для принятия решения в процентах.

sla-fail-log-period integer	Устаревшее, пожалуйста, переименуйте на sla_fail_log_period. Интервал времени в секундах, в течение которого будут генерироваться сообщения журнала о сбое SLA.
sla-pass-log-period integer	Устаревшее, пожалуйста, переименуйте на sla_pass_log_period. Интервал времени в секундах, в течение которого будут генерироваться сообщения журнала об успехе SLA.
system-dns string	Устаревшее, пожалуйста, переименуйте на system_dns. Включить/выключить систему DNS в качестве сервера зондирования. Варианты: `"disable"` `"enable"`
threshold-alert-jitter integer	Устаревшее, пожалуйста, переименуйте на threshold_alert_jitter. Пороговое значение оповещения для джиттера.
threshold-alert-latency integer	Устаревшее, пожалуйста, переименуйте на threshold_alert_latency. Пороговое значение оповещения для задержки.
threshold-alert-packetloss integer	Устаревшее, пожалуйста, переименуйте на threshold_alert_packetloss. Пороговое значение оповещения для потери пакетов.
threshold-warning-jitter integer	Устаревшее, пожалуйста, переименуйте на threshold_warning_jitter. Предупреждающий порог для джиттера.
threshold-warning-latency integer	Устаревшее, пожалуйста, переименуйте на threshold_warning_latency. Предупреждающий порог для задержки.
threshold-warning-packetloss integer	Устаревшее, пожалуйста, переименуйте на threshold_warning_packetloss. Предупреждающий порог для потери пакетов.
timeout integer	Сколько времени ждать ответа от сервера, чтобы считать попытку подключения неудачной.
update-cascade-interface string	Устаревшее, пожалуйста, переименуйте на update_cascade_interface. Включить/выключить обновление интерфейса каскада. Варианты: `"disable"` `"enable"`
update-static-route string	Устаревшее, пожалуйста, переименуйте на update_static_route. Включить/выключить обновление статического маршрута. Варианты: `"disable"` `"enable"`
workspace_locking_adom string	Область, которая должна быть заблокирована для FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая корневой.
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 помогают в этой работе.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой при возврате ненулевого rc. Вы также можете переопределить условия для завершения выполнение ошибкой или успехом с параметрами rc_failed и rc_succeeded.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  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.
      fortinet.fortimanager.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: present # <value in [present, absent]>
        wanprof_system_virtualwanlink_healthcheck:
          _dynamic_server: <string>
          addr_mode: <value in [ipv4, ipv6]>
          failtime: <integer>
          http_agent: <string>
          http_get: <string>
          http_match: <string>
          interval: <integer>
          members: <list or string>
          name: <string>
          packet_size: <integer>
          password: <list or string>
          port: <integer>
          protocol: <value in [ping, tcp-echo, udp-echo, ...]>
          recoverytime: <integer>
          security_mode: <value in [none, authentication]>
          server: <list or string>
          sla:
            -
              id: <integer>
              jitter_threshold: <integer>
              latency_threshold: <integer>
              link_cost_factor:
                - latency
                - jitter
                - packet-loss
              packetloss_threshold: <integer>
          threshold_alert_jitter: <integer>
          threshold_alert_latency: <integer>
          threshold_alert_packetloss: <integer>
          threshold_warning_jitter: <integer>
          threshold_warning_latency: <integer>
          threshold_warning_packetloss: <integer>
          update_cascade_interface: <value in [disable, enable]>
          update_static_route: <value in [disable, enable]>
          internet_service_id: <string>
          probe_packets: <value in [disable, enable]>
          sla_fail_log_period: <integer>
          sla_pass_log_period: <integer>
          timeout: <integer>
          ha_priority: <integer>
          diffservcode: <string>
          probe_timeout: <integer>
          dns_request_domain: <string>
          probe_count: <integer>
          system_dns: <value in [disable, enable]>

Значения возврата

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_wanprof_system_virtualwanlink_healthcheck_module.html