Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_system_link_monitor — настройка монитора состояния канала в Fortinet FortiOS и FortiGate.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_system_link_monitor.

Добавлено в fortinet.fortios 2.0.0

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

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

  • Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), устанавливая и изменяя параметры системных функций и категории link_monitor. Перед использованием необходимо настроить все параметры и значения примеров в соответствии с источниками данных. Протестировано с FOS v6.0.0

Требования

На узле, выполняющем этот модуль, должны быть выполнены следующие требования.

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

Аутентификация на основе токена. Создаётся в графическом интерфейсе FortiGate.

enable_log

boolean

Включить или отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

member_path

string

Путь к атрибуту элемента, над которым выполняется операция.

Если атрибутов больше одного, они разделяются символом косой черты.

Параметр member_path используется для выполнения операций с элементами.

member_state

string

Добавить или удалить элемент по указанному пути к атрибуту.

Если задан параметр member_state, параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

state

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

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

Варианты:

  • "present"
  • "absent"

system_link_monitor

dictionary

Настройка монитора состояния канала.

addr_mode

string

Режим адресации (IPv4 или IPv6).

Варианты:

  • "ipv4"
  • "ipv6"

class_id

integer

Идентификатор класса трафика. Источник: firewall.traffic-class.class-id.

diffservcode

string

Код дифференцированного обслуживания (DSCP) в заголовке IP пробного пакета.

fail_weight

integer

Пороговое значение веса для запуска оповещения о сбое канала.

failtime

integer

Количество повторных попыток, после которого сервер считается недоступным (1–3600).

gateway_ip

string

IP-адрес шлюза, используемый для проверки сервера.

gateway_ip6

string

IPv6-адрес шлюза, используемый для проверки сервера.

ha_priority

integer

Приоритет при выборе HA (1–50).

http_agent

string

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

http_get

string

При мониторинге HTML-сервера можно отправить запрос HTTP-GET с пользовательской строкой. Используйте этот параметр, чтобы задать строку.

http_match

string

Строка, которую ожидается увидеть в запросах HTTP-GET отслеживаемого трафика.

interval

integer

Интервал обнаружения в миллисекундах (20–3600 * 1000 мс).

name

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

Имя монитора канала.

packet_size

integer

Размер пакета в тестовом сеансе TWAMP (124/158–1024).

password

string

Пароль контроллера TWAMP в режиме аутентификации.

port

integer

Номер порта трафика, используемого для мониторинга сервера.

probe_count

integer

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

probe_timeout

integer

Время ожидания, по истечении которого пробный пакет считается потерянным (20–5000 мс).

protocol

list / elements=string

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

Варианты:

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

recoverytime

integer

Количество успешных ответов, после получения которых сервер считается восстановившимся (1–3600).

route

list / elements=dictionary

Подсеть для мониторинга.

subnet

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

IP-адрес и маска подсети (x.x.x.x/y).

security_mode

string

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

Варианты:

  • "none"
  • "authentication"

server

list / elements=dictionary

IP-адреса серверов, подлежащих мониторингу.

address

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

Адрес сервера.

server_config

string

Режим настройки сервера.

Варианты:

  • "default"
  • "individual"

server_list

list / elements=dictionary

Серверы для мониторинга link-monitor.

dst

string

IP-адрес сервера, подлежащего мониторингу.

id

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

Идентификатор сервера. См. <a href=’#notes’>Примечания</a>.

port

integer

Номер порта трафика, используемого для мониторинга сервера.

protocol

list / elements=string

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

Варианты:

  • "ping"
  • "tcp-echo"
  • "udp-echo"
  • "http"
  • "https"
  • "twamp"

weight

integer

Вес монитора для этого dst (0–255).

server_type

string

Тип сервера (статический или динамический).

Варианты:

  • "static"
  • "dynamic"

service_detection

string

Использовать монитор только для считывания показателей качества. Если параметр включён, статические маршруты и каскадные интерфейсы обновляться не будут.

Варианты:

  • "enable"
  • "disable"

source_ip

string

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

source_ip6

string

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

srcintf

string

Интерфейс, получающий отслеживаемый трафик. Источник: system.interface.name.

status

string

Включить или отключить этот монитор канала.

Варианты:

  • "enable"
  • "disable"

update_cascade_interface

string

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

Варианты:

  • "enable"
  • "disable"

update_policy_route

string

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

Варианты:

  • "enable"
  • "disable"

update_static_route

string

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

Варианты:

  • "enable"
  • "disable"

vdom

string

Виртуальный домен из числа предварительно определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

По умолчанию: "root"

Примечания

Примечание

  • Устаревший fortiosapi объявлен устаревшим; предпочтительный способ запуска плейбуков — httpapi.
  • Модуль поддерживает check_mode.

Примеры

- name: Configure Link Health Monitor.
  fortinet.fortios.fortios_system_link_monitor:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_link_monitor:
          addr_mode: "ipv4"
          class_id: "0"
          diffservcode: "<your_own_value>"
          fail_weight: "0"
          failtime: "5"
          gateway_ip: "<your_own_value>"
          gateway_ip6: "<your_own_value>"
          ha_priority: "1"
          http_agent: "<your_own_value>"
          http_get: "<your_own_value>"
          http_match: "<your_own_value>"
          interval: "500"
          name: "default_name_15"
          packet_size: "124"
          password: "<your_own_value>"
          port: "0"
          probe_count: "30"
          probe_timeout: "500"
          protocol: "ping"
          recoverytime: "5"
          route:
              -
                  subnet: "<your_own_value>"
          security_mode: "none"
          server:
              -
                  address: "<your_own_value>"
          server_config: "default"
          server_list:
              -
                  dst: "<your_own_value>"
                  id: "31"
                  port: "0"
                  protocol: "ping"
                  weight: "0"
          server_type: "static"
          service_detection: "enable"
          source_ip: "84.230.14.43"
          source_ip6: "<your_own_value>"
          srcintf: "<your_own_value> (source system.interface.name)"
          status: "enable"
          update_cascade_interface: "enable"
          update_policy_route: "enable"
          update_static_route: "enable"

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

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

Ключ

Описание

build

string

Номер сборки образа FortiGate

Возвращается: всегда

Пример: "1547"

http_method

string

Последний метод, использованный для передачи содержимого в FortiGate

Возвращается: всегда

Пример: "PUT"

http_status

string

Последний результат, возвращённый FortiGate при последней выполненной операции

Возвращается: всегда

Пример: "200"

mkey

string

Главный ключ (идентификатор), использованный при последнем вызове FortiGate

Возвращается: при успехе

Пример: "id"

name

string

Имя таблицы, использованной для выполнения запроса

Возвращается: всегда

Пример: "urlfilter"

path

string

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

Возвращается: всегда

Пример: "webfilter"

revision

string

Внутренний номер ревизии

Возвращается: всегда

Пример: "17.0.2.10658"

serial

string

Серийный номер устройства

Возвращается: всегда

Пример: "FGVMEVYYQT3AB5352"

status

string

Результат выполнения операции

Возвращается: всегда

Пример: "success"

vdom

string

Используемый виртуальный домен

Возвращается: всегда

Пример: "root"

version

string

Версия FortiGate

Возвращается: всегда

Пример: "v5.6.3"

Авторы

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Ссылки на коллекцию

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

© 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/fortios/fortios_system_link_monitor_module.html

Spec-Zone.ru

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