Модуль fortinet.fortios.fortios_router_static — настройка таблиц статической маршрутизации IPv4 в Fortinet FortiOS и FortiGate.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_router_static.
Добавлено в fortinet.fortios 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функции маршрутизатора и категории static. Перед использованием необходимо скорректировать все параметры и значения примеров в соответствии с источниками данных. Протестировано с FOS v6.0.0
Требования
На узле, выполняющем этот модуль, должны быть соблюдены следующие требования.
- ansible>=2.16
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Аутентификация на основе токена. Создаётся в графическом интерфейсе FortiGate. |
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
member_path string | Путь к атрибуту элемента, над которым выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с пометкой member_path подходит для выполнения операции с элементом. |
member_state string | Добавить или удалить элемент по указанному пути к атрибуту. Если задан member_state, параметр state игнорируется. Варианты:
|
router_static dictionary | Настройка таблиц статической маршрутизации IPv4. |
|
bfd string |
Включить или отключить двунаправленное обнаружение пересылки (BFD). Варианты:
|
|
blackhole string |
Включить или отключить маршрут в чёрную дыру. Варианты:
|
|
comment string |
Необязательные комментарии. |
|
device string |
Выходной интерфейс шлюза или туннель. Источник: system.interface.name. |
|
distance integer |
Административное расстояние (1–255). |
|
dst string |
IP-адрес назначения и маска для этого маршрута. |
|
dstaddr string |
Имя адреса брандмауэра или группы адресов. Источники: firewall.address.name, firewall.addrgrp.name. |
|
dynamic_gateway string |
Разрешить использование динамического шлюза, полученного от DHCP- или PPP-сервера. Варианты:
|
|
gateway string |
IP-адрес шлюза для этого маршрута. |
|
internet_service integer |
Идентификатор приложения в базе данных интернет-сервисов. Источник: firewall.internet-service.id. |
|
internet_service_custom string |
Имя приложения в пользовательской базе данных интернет-сервисов. Источник: firewall.internet-service-custom.name. |
|
internet_service_fortiguard string |
Имя приложения в базе данных интернет-сервисов FortiGuard. Источник: firewall.internet-service-fortiguard.name. |
|
link_monitor_exempt string |
Включить или отключить удаление этого статического маршрута при отказе монитора канала или проверки работоспособности. Варианты:
|
|
preferred_source string |
Предпочтительный IP-адрес источника для этого маршрута. |
|
priority integer |
Административный приоритет (1–65535). |
|
sdwan string |
Включить или отключить исходящий трафик через SD-WAN. Варианты:
|
|
sdwan_zone list / elements=dictionary |
Выберите зону SD-WAN. |
|
name string / обязательный |
Имя зоны SD-WAN. Источник: system.sdwan.zone.name. |
|
seq_num integer / обязательный |
Порядковый номер. См. <a href=’#notes’>примечания</a>. |
|
src string |
Префикс источника для этого маршрута. |
|
status string |
Включить или отключить этот статический маршрут. Варианты:
|
|
tag integer |
Метка маршрута. |
|
virtual_wan_link string |
Включить или отключить исходящий трафик через virtual-wan-link. Варианты:
|
|
vrf integer |
Идентификатор Virtual Routing Forwarding. |
|
weight integer |
Административный вес (0–255). |
state string / обязательный | Указывает, нужно ли создать или удалить объект. Варианты:
|
vdom string | Виртуальный домен из числа ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Настоятельно рекомендуем указывать собственное значение seq_num вместо 0. Значение «0» — специальный заполнитель, позволяющий серверной части назначить объекту последний доступный номер, но у этого варианта есть ограничения. Подробнее см. в разделе «Вопросы и ответы».
- Устаревшая библиотека fortiosapi объявлена устаревшей; для запуска плейбуков рекомендуется использовать httpapi.
- Модуль поддерживает check_mode.
Примеры
- name: Configure IPv4 static routing tables.
fortinet.fortios.fortios_router_static:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
router_static:
bfd: "enable"
blackhole: "enable"
comment: "Optional comments."
device: "<your_own_value> (source system.interface.name)"
distance: "10"
dst: "<your_own_value>"
dstaddr: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
dynamic_gateway: "enable"
gateway: "<your_own_value>"
internet_service: "0"
internet_service_custom: "<your_own_value> (source firewall.internet-service-custom.name)"
internet_service_fortiguard: "<your_own_value> (source firewall.internet-service-fortiguard.name)"
link_monitor_exempt: "enable"
preferred_source: "<your_own_value>"
priority: "1"
sdwan: "enable"
sdwan_zone:
-
name: "default_name_20 (source system.sdwan.zone.name)"
seq_num: "<you_own_value>"
src: "<your_own_value>"
status: "enable"
tag: "0"
virtual_wan_link: "enable"
vrf: "unspecified"
weight: "0"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа FortiGate Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для передачи содержимого на FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, возвращённый FortiGate при выполнении последней операции Возвращается: всегда Пример: |
mkey string | Мастер-ключ (идентификатор), использованный при последнем вызове FortiGate Возвращается: при успехе Пример: |
name string | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер ревизии Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Результат операции Возвращается: всегда Пример: |
vdom string | Используемый виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_router_static_module.html