fortinet.fortios.fortios_system_link_monitor модуль — Настройка монитора состояния канала в FortiOS и FortiGate Fortinet.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.3.7).
Возможно, эта коллекция уже установлена, если вы используете пакет 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.15
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Аутентификация на основе токена. Сгенерирован из GUI Fortigate. |
enable_log логический | Включить/выключить логирование для задачи. Варианты:
|
member_path строка | Путь к атрибуту элемента для обработки. Разделяется символом косой черты, если атрибутов несколько. Параметр, помеченный member_path, подходит для выполнения операции с элементом. |
member_state строка | Добавить или удалить элемент в указанном пути атрибута. При указании member_state параметр state игнорируется. Варианты:
|
state строка / обязательно | Указывает на создание или удаление объекта. Варианты:
|
system_link_monitor словарь | Настройка монитора состояния канала. |
|
addr_mode строка |
Режим адреса (IPv4 или IPv6). Варианты:
|
|
class_id целое число |
Идентификатор класса трафика. Источник firewall.traffic-class.class-id. |
|
diffservcode строка |
Код точки дифференцированных служб (DSCP) в заголовке IP пробного пакета. |
|
fail_weight целое число |
Весовой порог для срабатывания предупреждения о неполадке канала. |
|
failtime целое число |
Количество попыток повторной проверки, прежде чем сервер будет считаться нерабочим (1 - 3600). |
|
gateway_ip строка |
IP-адрес шлюза, используемый для проверки сервера. |
|
gateway_ip6 строка |
IPv6-адрес шлюза, используемый для проверки сервера. |
|
ha_priority целое число |
Приоритет выбора HA (1 - 50). |
|
http_agent строка |
Строка в поле http-agent в заголовке HTTP. |
|
http_get строка |
Если вы отслеживаете веб-сервер, вы можете отправить HTTP-запрос GET с пользовательской строкой. Используйте этот параметр для определения строки. |
|
http_match строка |
Строка, которую вы ожидаете увидеть в запросах HTTP-GET отслеживаемого трафика. |
|
interval целое число |
Интервал обнаружения в миллисекундах (20 - 3600 * 1000 мсек). |
|
name строка / обязательно |
Имя монитора состояния канала. |
|
packet_size целое число |
Размер пакета сеанса тестирования TWAMP (124/158 - 1024). |
|
password строка |
Пароль контроллера TWAMP в режиме аутентификации. |
|
port целое число |
Номер порта используемого трафика для мониторинга сервера. |
|
probe_count целое число |
Количество последних зондирований, которые должны использоваться для расчета задержки и джиттера (5 - 30). |
|
probe_timeout integer |
Время ожидания, прежде чем пакет зондирования будет считаться потерянным (20 - 5000 мс). |
|
protocol list / elements=string |
Протоколы, используемые для мониторинга сервера. Choices:
|
|
recoverytime integer |
Количество успешных ответов, полученных до того, как сервер будет считаться восстановленным (1 - 3600). |
|
route list / elements=dictionary |
Подсеть для мониторинга. |
|
subnet string / required |
IP-адрес и маска сети (x.x.x.x/y). |
|
security_mode string |
Режим безопасности контроллера Twamp. Choices:
|
|
server list / elements=dictionary |
IP-адрес(а) сервера(ов), которые необходимо контролировать. |
|
address string / required |
Адрес сервера. |
|
server_config string |
Режим настройки сервера. Choices:
|
|
server_list list / elements=dictionary |
Серверы для мониторинга link-monitor. |
|
dst string |
IP-адрес сервера, который нужно контролировать. |
|
id integer / required |
Идентификатор сервера. см. <a href=’#notes’>Примечания</a>. |
|
port integer |
Номер порта трафика, который будет использоваться для мониторинга сервера. |
|
protocol list / elements=string |
Протоколы, используемые для мониторинга сервера. Choices:
|
|
weight integer |
Вес монитора для этого пункта назначения (0 - 255). |
|
server_type string |
Тип сервера (статический или динамический). Choices:
|
|
service_detection string |
Использовать монитор только для чтения значений качества. Если включено, статические маршруты и каскадные интерфейсы обновляться не будут. Choices:
|
|
source_ip string |
Исходный IP-адрес, используемый в пакете для сервера. |
|
source_ip6 string |
Исходный IPv6-адрес, используемый в пакете для сервера. |
|
srcintf string |
Интерфейс, который получает трафик для мониторинга. Исходная система.имя_интерфейса. |
|
status string |
Включить/отключить этот монитор связи. Choices:
|
|
update_cascade_interface string |
Включить/отключить обновление каскадного интерфейса. Choices:
|
|
update_policy_route string |
Включить/отключить обновление маршрута политики. Choices:
|
|
update_static_route string |
Включить/отключить обновление статического маршрута. Choices:
|
vdom string | Виртуальный домен, среди тех, которые были определены ранее. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. Default: |
Примечания
Примечание
- Устаревший fortiosapi был объявлен устаревшим, httpapi — предпочтительный способ запуска playbooks
- Модуль поддерживает 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 Возвращается: всегда Пример: |
http_method string | Последний метод, используемый для подготовки контента в FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, полученный от FortiGate при последней применённой операции Возвращается: всегда Пример: |
mkey string | Главный ключ (id), используемый в последнем вызове FortiGate Возвращается: успех Пример: |
name string | Имя таблицы, используемой для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, используемой для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер ревизии Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Указание результата операции Возвращается: всегда Пример: |
vdom string | Используемый виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/fortios/fortios_system_link_monitor_module.html
