fortinet.fortimanager.fmgr_wanprof_system_sdwan_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_sdwan_healthcheck.

Новая функция в fortinet.fortimanager 2.1.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_sdwan_healthcheck словарь	Настроены параметры верхнего уровня.
_dynamic-server строка	Устарело, пожалуйста, переименуйте на _dynamic_server. Динамический сервер.
addr-mode строка	Устарело, пожалуйста, переименуйте на addr_mode. Режим адреса Варианты: `"ipv4"` `"ipv6"`
class-id строка	Устарело, пожалуйста, переименуйте на class_id. Идентификатор класса трафика.
detect-mode строка	Устарело, пожалуйста, переименуйте на detect_mode. Режим определения сервера. Варианты: `"active"` `"passive"` `"prefer-passive"` `"remote"` `"agent-based"`
diffservcode строка	Код точки дифференцированных служб
dns-match-ip строка	Устарело, пожалуйста, переименуйте на dns_match_ip. Ожидаемый IP-адрес ответа от DNS-сервера, если протокол DNS.
dns-request-domain строка	Устарело, пожалуйста, переименуйте на dns_request_domain. Полное доменное имя для разрешения DNS-проб.
embed-measured-health строка	Устарело, пожалуйста, переименуйте на embed_measured_health. Включить/выключить встраивание измеряемой информации о состоянии здоровья. Варианты: `"disable"` `"enable"`
failtime целое число	Количество неудач, после которых сервер считается потерянным

END_OF_DOCUMENT_MARKER

ftp-file string	Устарело, переименуйте в ftp_file. Полный путь и имя файла на FTP-сервере для загрузки проверки работоспособности FTP.
ftp-mode string	Устарело, переименуйте в ftp_mode. Режим FTP. Choices: `"passive"` `"port"`
ha-priority integer	Устарело, переименуйте в ha_priority. Приоритет выбора HA
http-agent string	Устарело, переименуйте в http_agent. Строка в поле http-agent в HTTP-заголовке.
http-get string	Устарело, переименуйте в http_get. URL-адрес, используемый для связи с сервером, если протокол — HTTP.
http-match string	Устарело, переименуйте в http_match. Ожидаемая строка ответа от сервера, если протокол — HTTP.
interval integer	Интервал проверки состояния в миллисекундах или время между попытками подключения к серверу
members any	(список или строка) Список номеров последовательности участников.
mos-codec string	Устарело, переименуйте в mos_codec. Кодек для использования при расчете MOS Choices: `"g711"` `"g722"` `"g729"`
name string / required	Имя проверки состояния или работоспособности.
packet-size integer	Устарело, переименуйте в packet_size. Размер пакета сессии теста twamp,
password any	(список) Пароль контроллера Twamp в режиме аутентификации
port integer	Номер порта, используемый для связи с сервером по выбранному протоколу
probe-count integer	Устарело, переименуйте в probe_count. Количество последних зондов, которые должны использоваться для вычисления задержки и джиттера
probe-packets string	Устарело, переименуйте в probe_packets. Включить/отключить передачу пакетов зондирования. Choices: `"disable"` `"enable"`
probe-timeout integer	Устарело, переименуйте в probe_timeout. Время ожидания, прежде чем пакет зондирования будет считаться потерянным
protocol string	Протокол, используемый для определения того, может ли FortiGate общаться с сервером. Choices: `"ping"` `"tcp-echo"` `"udp-echo"` `"http"` `"twamp"` `"ping6"` `"dns"` `"tcp-connect"` `"ftp"` `"https"`
quality-measured-method string	Устарело, переименуйте в quality_measured_method. Метод измерения качества tcp-connect. Choices: `"half-close"` `"half-open"`
recoverytime integer	Количество полученных успешных ответов, прежде чем сервер будет считаться восстановленным
security-mode string	Устарело, переименуйте в security_mode. Режим безопасности контроллера Twamp. Choices: `"none"` `"authentication"`

server any	(list) IP-адрес или FQDN сервера.
sla list / elements=dictionary	SLA.
id integer	ID 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"` `"mos"` `"remote"`
mos-threshold string	Устаревшее значение, замените на mos_threshold. Минимальный средний балл мнений для успешной SLA.
packetloss-threshold integer	Устаревшее значение, замените на packetloss_threshold. Потеря пакетов для принятия решения в процентах.
priority-in-sla integer	Устаревшее значение, замените на priority_in_sla. Значение, распределяемое в таблицу маршрутизации при условии in-sla.
priority-out-sla integer	Устаревшее значение, замените на priority_out_sla. Значение, распределяемое в таблицу маршрутизации при условии out-sla.
sla-fail-log-period integer	Устаревшее значение, замените на sla_fail_log_period. Интервал времени в секундах, по которому генерируются сообщения о сбоях SLA.
sla-id-redistribute integer	Устаревшее значение, замените на sla_id_redistribute. Выбор ID из подтаблицы SLA.
sla-pass-log-period integer	Устаревшее значение, замените на sla_pass_log_period. Интервал времени в секундах, по которому генерируются сообщения об успехе SLA.
source string	IP-адрес источника, используемый в пакете проверки работоспособности для сервера.
source6 string	IPv6-адрес источника, используемый в пакете проверки работоспособности для сервера.
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. Пороговое значение предупреждения по потере пакетов
update-cascade-interface string	Устаревший, пожалуйста, переименуйте его в update_cascade_interface. Включить/выключить обновление каскадных интерфейсов. Варианты: `"disable"` `"enable"`
update-static-route string	Устаревший, пожалуйста, переименуйте его в update_static_route. Включить/выключить обновление статического маршрута. Варианты: `"disable"` `"enable"`
user string	Имя пользователя для доступа к серверу зондирования.
vrf integer	Идентификатор виртуального маршрутизирующего шлюза.
workspace_locking_adom string	ADOM для блокировки 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_sdwan_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_sdwan_healthcheck:
          _dynamic_server: <string>
          addr_mode: <value in [ipv4, ipv6]>
          diffservcode: <string>
          dns_match_ip: <string>
          dns_request_domain: <string>
          failtime: <integer>
          ftp_file: <string>
          ftp_mode: <value in [passive, port]>
          ha_priority: <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>
          probe_count: <integer>
          probe_packets: <value in [disable, enable]>
          probe_timeout: <integer>
          protocol: <value in [ping, tcp-echo, udp-echo, ...]>
          quality_measured_method: <value in [half-close, half-open]>
          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
                - mos
                - remote
              packetloss_threshold: <integer>
              mos_threshold: <string>
              priority_in_sla: <integer>
              priority_out_sla: <integer>
          sla_fail_log_period: <integer>
          sla_pass_log_period: <integer>
          system_dns: <value in [disable, enable]>
          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]>
          user: <string>
          detect_mode: <value in [active, passive, prefer-passive, ...]>
          mos_codec: <value in [g711, g722, g729]>
          source: <string>
          vrf: <integer>
          embed_measured_health: <value in [disable, enable]>
          sla_id_redistribute: <integer>
          class_id: <string>
          source6: <string>

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

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

Ключ	Описание
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_sdwan_healthcheck_module.html