Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_wanprof_system_sdwan_healthcheckfortiguard — проверка состояния 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_sdwan_healthcheckfortiguard.

Добавлено в fortinet.fortimanager 2.14.0

  • Краткое описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Этот модуль позволяет настраивать устройство FortiManager.
  • В примерах приведены все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.

Параметры

Параметр

Комментарии

access_token

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

string / required

Параметр (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 / required

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

Варианты:

  • "present"
  • "absent"

wanprof

string / required

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

wanprof_system_sdwan_healthcheckfortiguard

dictionary

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

addr_mode

aliases: addr-mode

string

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

Варианты:

  • "ipv4"
  • "ipv6"

class_id

aliases: class-id

list / elements=string

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

detect_mode

aliases: detect-mode

string

Режим определения сервера.

Варианты:

  • "active"
  • "passive"
  • "prefer-passive"
  • "remote"
  • "agent-based"

diffservcode

string

Кодовая точка дифференцированного обслуживания

dns_match_ip

aliases: dns-match-ip

string

Ожидаемый IP-адрес в ответе DNS-сервера, если используется протокол DNS.

dns_request_domain

aliases: dns-request-domain

string

Полное доменное имя для разрешения при проверке DNS.

embed_measured_health

aliases: embed-measured-health

string

Включить или отключить встраивание сведений об измеренном состоянии.

Варианты:

  • "disable"
  • "enable"

failtime

integer

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

ftp_file

aliases: ftp-file

string

Полный путь и имя файла на FTP-сервере для загрузки при проверке состояния FTP.

ftp_mode

aliases: ftp-mode

string

Режим FTP.

Варианты:

  • "passive"
  • "port"

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.

interval

integer

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

members

list / elements=string

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

mos_codec

aliases: mos-codec

string

Кодек для расчета MOS

Варианты:

  • "g711"
  • "g722"
  • "g729"

packet_size

aliases: packet-size

integer

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

password

list / elements=string

Пароль контроллера 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"
  • "dns"
  • "tcp-connect"
  • "ftp"
  • "https"

quality_measured_method

aliases: quality-measured-method

string

Метод измерения качества tcp-connect.

Варианты:

  • "half-close"
  • "half-open"

recoverytime

integer

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

security_mode

aliases: security-mode

string

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

Варианты:

  • "none"
  • "authentication"

server

list / elements=string

Предопределенный IP-адрес или имя FQDN из FortiGuard.

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"
  • "mos"
  • "remote"

mos_threshold

aliases: mos-threshold

string

Минимальная средняя оценка качества (MOS), при которой SLA считается выполненным.

packetloss_threshold

aliases: packetloss-threshold

integer

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

priority_in_sla

aliases: priority-in-sla

integer

Значение, добавляемое в таблицу маршрутизации при выполнении SLA

priority_out_sla

aliases: priority-out-sla

integer

Значение, добавляемое в таблицу маршрутизации при невыполнении SLA

sla_fail_log_period

aliases: sla-fail-log-period

integer

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

sla_id_redistribute

aliases: sla-id-redistribute

integer

Выберите идентификатор из подтаблицы SLA.

sla_pass_log_period

псевдонимы: sla-pass-log-period

integer

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

source

string

Исходный IP-адрес, используемый в пакете проверки работоспособности, отправляемом на сервер.

source6

string

Исходный IPv6-адрес, используемый в пакете проверки работоспособности, отправляемом на сервер.

system_dns

псевдонимы: system-dns

string

Включить/отключить использование системного DNS в качестве сервера проверки.

Варианты:

  • "disable"
  • "enable"

target_name

псевдонимы: target-name

string

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

threshold_alert_jitter

псевдонимы: threshold-alert-jitter

integer

Пороговое значение задержки для оповещения

threshold_alert_latency

псевдонимы: threshold-alert-latency

integer

Пороговое значение задержки для оповещения

threshold_alert_packetloss

псевдонимы: threshold-alert-packetloss

integer

Пороговое значение потери пакетов для оповещения

threshold_warning_jitter

псевдонимы: threshold-warning-jitter

integer

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

threshold_warning_latency

псевдонимы: threshold-warning-latency

integer

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

threshold_warning_packetloss

псевдонимы: threshold-warning-packetloss

integer

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

update_cascade_interface

псевдонимы: update-cascade-interface

string

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

Варианты:

  • "disable"
  • "enable"

update_static_route

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

string

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

Варианты:

  • "disable"
  • "enable"

user

string

Имя пользователя для доступа к серверу проверки.

vrf

integer

Идентификатор виртуальной маршрутизации и переадресации.

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_sdwan_healthcheckfortiguard:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        wanprof: <your own value>
        state: present # <value in [present, absent]>
        wanprof_system_sdwan_healthcheckfortiguard:
          # addr_mode: <value in [ipv4, ipv6]>
          # class_id: <list or string>
          # detect_mode: <value in [active, passive, prefer-passive, ...]>
          # diffservcode: <string>
          # dns_match_ip: <string>
          # dns_request_domain: <string>
          # embed_measured_health: <value in [disable, enable]>
          # 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>
          # mos_codec: <value in [g711, g722, g729]>
          # 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"]
          #     mos_threshold: <string>
          #     packetloss_threshold: <integer>
          #     priority_in_sla: <integer>
          #     priority_out_sla: <integer>
          # sla_fail_log_period: <integer>
          # sla_id_redistribute: <integer>
          # sla_pass_log_period: <integer>
          # source: <string>
          # source6: <string>
          # system_dns: <value in [disable, enable]>
          # target_name: <string>
          # 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>
          # vrf: <integer>

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

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

Ключ

Описание

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

Spec-Zone.ru

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