Spec-Zone.ru › Ansible

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

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

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

Добавлено в fortinet.fortimanager 2.0.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.

proposed_method

string

Метод, переопределяющий метод базового запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

list / elements=integer

Список кодов rc, переопределяющий условия сбоя.

rc_succeeded

list / elements=integer

Список кодов rc, переопределяющий условия успешного выполнения.

state

string / обязательный

Указание создать, обновить или удалить объект.

Варианты:

  • "present"
  • "absent"

wanprof

string / обязательный

Параметр (wanprof) в запрошенном URL.

wanprof_system_virtualwanlink_healthcheck

dictionary

Набор параметров верхнего уровня.

_dynamic_server

aliases: _dynamic-server

string

Динамический сервер.

addr_mode

aliases: addr-mode

string

Режим адресации

Варианты:

  • "ipv4"
  • "ipv6"

diffservcode

string

Код дифференцированного обслуживания (DSCP)

dns_request_domain

aliases: dns-request-domain

string

Полное доменное имя, которое необходимо разрешить при проверке DNS.

failtime

integer

Количество сбоев, после которого сервер считается недоступным

ha_priority

aliases: ha-priority

integer

Приоритет выбора в кластере высокой доступности

http_agent

aliases: http-agent

string

Строка в поле http-agent заголовка HTTP.

http_get

aliases: http-get

string

URL для связи с сервером, если используется протокол HTTP.

http_match

aliases: http-match

string

Ожидаемая строка ответа сервера, если используется протокол HTTP.

internet_service_id

aliases: internet-service-id

string

Идентификатор интернет-службы.

interval

integer

Интервал проверки состояния или время между попытками подключения к серверу

members

any

(список или строка) Список порядковых номеров участников.

name

string / обязательный

Имя проверки состояния или работоспособности.

packet_size

aliases: packet-size

integer

Размер пакета в тестовом сеансе TWAMP,

password

any

(список) Пароль контроллера TWAMP в режиме аутентификации

port

integer

Номер порта для связи с сервером по выбранному протоколу.

probe_count

aliases: probe-count

integer

Количество последних проб, используемых для расчёта задержки и джиттера

probe_packets

aliases: probe-packets

string

Включить или отключить передачу пробных пакетов.

Варианты:

  • "disable"
  • "enable"

probe_timeout

aliases: probe-timeout

integer

Время ожидания, прежде чем пробный пакет будет считаться потерянным

protocol

string

Протокол, используемый для определения возможности FortiGate обмениваться данными с сервером.

Варианты:

  • "ping"
  • "tcp-echo"
  • "udp-echo"
  • "http"
  • "twamp"
  • "ping6"
  • "dns"

recoverytime

integer

Количество успешных ответов, после которого сервер считается восстановившимся

security_mode

aliases: security-mode

string

Режим безопасности контроллера TWAMP.

Варианты:

  • "none"
  • "authentication"

server

any

(список) IP-адрес или полное доменное имя сервера.

sla

list / elements=dictionary

SLA.

id

integer

Идентификатор SLA.

jitter_threshold

aliases: jitter-threshold

integer

Порог джиттера в миллисекундах для принятия решения по SLA.

latency_threshold

aliases: latency-threshold

integer

Порог задержки в миллисекундах для принятия решения по SLA.

link_cost_factor

aliases: link-cost-factor

list / elements=string

Критерии выбора канала.

Варианты:

  • "latency"
  • "jitter"
  • "packet-loss"

packetloss_threshold

aliases: packetloss-threshold

integer

Порог потери пакетов в процентах для принятия решения по SLA.

sla_fail_log_period

aliases: sla-fail-log-period

integer

Интервал в секундах, с которым будут создаваться сообщения журнала о сбоях SLA

sla_pass_log_period

aliases: sla-pass-log-period

integer

Интервал в секундах, с которым будут создаваться сообщения журнала об успешном выполнении SLA

system_dns

aliases: system-dns

string

Включить или отключить системный DNS в качестве сервера проб.

Варианты:

  • "disable"
  • "enable"

threshold_alert_jitter

aliases: threshold-alert-jitter

integer

Порог предупреждения для джиттера

threshold_alert_latency

aliases: threshold-alert-latency

integer

Порог предупреждения для задержки

threshold_alert_packetloss

aliases: threshold-alert-packetloss

integer

Порог предупреждения для потери пакетов

threshold_warning_jitter

aliases: threshold-warning-jitter

integer

Порог предупреждения для джиттера

threshold_warning_latency

aliases: threshold-warning-latency

integer

Порог предупреждения для задержки

threshold_warning_packetloss

aliases: threshold-warning-packetloss

integer

Порог предупреждения для потери пакетов

timeout

integer

Время ожидания ответа от сервера, по истечении которого попытка подключения считается неудачной

update_cascade_interface

aliases: update-cascade-interface

string

Включить или отключить обновление каскадного интерфейса.

Варианты:

  • "disable"
  • "enable"

update_static_route

псевдонимы: update-static-route

string

Включить или отключить обновление статического маршрута.

Возможные значения:

  • "disable"
  • "enable"

workspace_locking_adom

string

ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другой ADOM, включая 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: SD-WAN status checking or health checking.
      fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_healthcheck:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        wanprof: <your own value>
        state: present # <value in [present, absent]>
        wanprof_system_virtualwanlink_healthcheck:
          name: "your value" # Required variable, string
          # _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>
          # 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

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_virtualwanlink_healthcheck_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API