Модуль fortinet.fortios.fortios_router_ospf — настройка OSPF в FortiOS и FortiGate от Fortinet.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: fortinet.fortios.fortios_router_ospf.
Добавлено в fortinet.fortios 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функции маршрутизатора и категории OSPF. Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием. Проверено с 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_ospf dictionary | Настройка OSPF. |
|
abr_type string |
Тип пограничного маршрутизатора области. Варианты:
|
|
area list / elements=dictionary |
Конфигурация области OSPF. |
|
authentication string |
Тип аутентификации. Варианты:
|
|
comments string |
Комментарий. |
|
default_cost integer |
Стоимость по умолчанию для суммарных маршрутов области-заглушки или NSSA. |
|
filter_list list / elements=dictionary |
Конфигурация списка фильтров области OSPF. |
|
direction string |
Направление. Варианты:
|
|
id integer / обязательный |
Идентификатор записи списка фильтров. См. <a href=’#notes’>Примечания</a>. |
|
list string |
Имя списка доступа или списка префиксов. Источник: router.access-list.name router.prefix-list.name. |
|
id string / обязательный |
IP-адрес записи области. |
|
nssa_default_information_originate string |
Перераспределять, объявлять или не создавать маршрут по умолчанию типа 7 в области NSSA. Варианты:
|
|
nssa_default_information_originate_metric integer |
Метрика OSPF по умолчанию. |
|
nssa_default_information_originate_metric_type string |
Тип метрики OSPF для маршрутов по умолчанию. Варианты:
|
|
nssa_redistribution string |
Включить/отключить перераспределение маршрутов в область NSSA. Варианты:
|
|
nssa_translator_role string |
Тип роли транслятора NSSA. Варианты:
|
|
range list / elements=dictionary |
Конфигурация диапазона области OSPF. |
|
advertise string |
Включить/отключить объявление. Варианты:
|
|
id integer / обязательный |
Идентификатор записи диапазона. См. <a href=’#notes’>Примечания</a>. |
|
prefix string |
Префикс. |
|
substitute string |
Подставляемый префикс. |
|
substitute_status string |
Включить/отключить подстановку. Варианты:
|
|
shortcut string |
Включить/отключить параметр shortcut. Варианты:
|
|
stub_type string |
Настройка суммарных маршрутов для области-заглушки. Варианты:
|
|
type string |
Настройка типа области. Варианты:
|
|
virtual_link list / elements=dictionary |
Конфигурация виртуального канала OSPF. |
|
authentication string |
Тип аутентификации. Варианты:
|
|
authentication_key string |
Ключ аутентификации. |
|
dead_interval integer |
Интервал ожидания. |
|
hello_interval integer |
Интервал Hello. |
|
keychain string |
Имя цепочки ключей дайджеста сообщений. Источник: router.key-chain.name. |
|
md5_key string |
Ключ MD5. |
|
md5_keychain string |
Имя цепочки ключей MD5 для аутентификации. Источник: router.key-chain.name. |
|
md5_keys list / elements=dictionary |
Ключ MD5. |
|
id integer / обязательный |
Идентификатор ключа (1–255). См. <a href=’#notes’>Примечания</a>. |
|
key_string string |
Пароль для ключа. |
|
name string / обязательный |
Имя записи виртуального канала. |
|
peer string |
IP-адрес узла-партнера. |
|
retransmit_interval integer |
Интервал повторной передачи. |
|
transmit_delay integer |
Задержка передачи. |
|
auto_cost_ref_bandwidth integer |
Эталонная пропускная способность в мегабитах в секунду. |
|
bfd string |
Обнаружение двунаправленной пересылки (BFD). Варианты:
|
|
database_overflow string |
Включить/отключить переполнение базы данных. Варианты:
|
|
database_overflow_max_lsas integer |
Максимальное число LSA при переполнении базы данных. |
|
database_overflow_time_to_recover integer |
Время восстановления после переполнения базы данных (с). |
|
default_information_metric integer |
Метрика информации по умолчанию. |
|
default_information_metric_type string |
Тип метрики информации по умолчанию. Варианты:
|
|
default_information_originate string |
Включить/отключить создание маршрута по умолчанию. Варианты:
|
|
default_information_route_map string |
Карта маршрутов для информации по умолчанию. Источник: router.route-map.name. |
|
default_metric integer |
Метрика по умолчанию для перераспределяемых маршрутов. |
|
distance integer |
Административное расстояние маршрута. |
|
distance_external integer |
Внешнее административное расстояние. |
|
distance_inter_area integer |
Межобластное административное расстояние. |
|
distance_intra_area integer |
Внутриобластное административное расстояние. |
|
distribute_list list / elements=dictionary |
Конфигурация списка распространения маршрутов. |
|
access_list string |
Имя списка доступа. Источник: router.access-list.name. |
|
id integer / обязательный |
Идентификатор записи списка распространения маршрутов. См. <a href=’#notes’>Примечания</a>. |
|
protocol string |
Тип протокола. Варианты:
|
|
distribute_list_in string |
Фильтрация входящих маршрутов. Источник: router.access-list.name router.prefix-list.name. |
|
distribute_route_map_in string |
Фильтрация входящих внешних маршрутов с помощью route-map. Источник: router.route-map.name. |
|
log_neighbour_changes string |
Ведение журнала изменений соседей OSPF. Варианты:
|
|
lsa_refresh_interval integer |
Минимальный интервал обновления LSA OSPF |
|
neighbor list / elements=dictionary |
Конфигурация соседей OSPF используется при работе OSPF в сетях без широковещания. |
|
cost integer |
Стоимость интерфейса, диапазон значений от 0 до 65535; 0 означает автоматическую стоимость. |
|
id integer / обязательный |
Идентификатор записи соседа. См. <a href=’#notes’>Примечания</a>. |
|
ip string |
IP-адрес интерфейса соседа. |
|
poll_interval integer |
Интервал опроса в секундах. |
|
priority integer |
Приоритет. |
|
network list / elements=dictionary |
Конфигурация сети OSPF. |
|
area string |
Привязать сеть к области. |
|
comments string |
Комментарий. |
|
id integer / обязательный |
Идентификатор записи сети. См. <a href=’#notes’>Примечания</a>. |
|
prefix string |
Префикс. |
|
ospf_interface list / elements=dictionary |
Конфигурация интерфейса OSPF. |
|
authentication string |
Тип аутентификации. Варианты:
|
|
authentication_key string |
Ключ аутентификации. |
|
bfd string |
Обнаружение двунаправленной пересылки (BFD). Варианты:
|
|
comments string |
Комментарий. |
|
cost integer |
Стоимость интерфейса, диапазон значений от 0 до 65535; 0 означает автоматическую стоимость. |
|
database_filter_out string |
Включение/отключение управления рассылкой LSA. Варианты:
|
|
dead_interval integer |
Интервал ожидания. |
|
hello_interval integer |
Интервал отправки Hello-пакетов. |
|
hello_multiplier integer |
Количество Hello-пакетов в течение интервала ожидания. |
|
interface string |
Имя настраиваемого интерфейса. Источник: system.interface.name. |
|
ip string |
IP-адрес. |
|
keychain string |
Имя цепочки ключей дайджеста сообщений. Источник: router.key-chain.name. |
|
linkdown_fast_failover string |
Включение/отключение быстрого переключения при потере связи. Варианты:
|
|
md5_key string |
Ключ MD5. |
|
md5_keychain string |
Имя цепочки ключей аутентификации MD5. Источник: router.key-chain.name. |
|
md5_keys list / elements=dictionary |
Ключ MD5. |
|
id integer / обязательный |
Идентификатор ключа (1–255). См. <a href=’#notes’>Примечания</a>. |
|
key_string string |
Пароль для ключа. |
|
mtu integer |
MTU для пакетов описания базы данных. |
|
mtu_ignore string |
Включение/отключение игнорирования MTU. Варианты:
|
|
name string / обязательный |
Имя записи интерфейса. |
|
network_type string |
Тип сети. Варианты:
|
|
prefix_length integer |
Длина префикса. |
|
priority integer |
Приоритет. |
|
resync_timeout integer |
Тайм-аут повторной синхронизации соседа при плавном перезапуске. |
|
retransmit_interval integer |
Интервал повторной передачи. |
|
status string |
Включение/отключение состояния. Варианты:
|
|
transmit_delay integer |
Задержка передачи. |
|
passive_interface list / elements=dictionary |
Конфигурация пассивного интерфейса. |
|
name string / обязательный |
Имя пассивного интерфейса. Источник: system.interface.name. |
|
redistribute list / elements=dictionary |
Конфигурация перераспределения маршрутов. |
|
metric integer |
Настройка метрики перераспределения маршрутов. |
|
metric_type string |
Тип метрики. Варианты:
|
|
name string / обязательный |
Имя перераспределяемого источника. |
|
routemap string |
Имя карты маршрутизации. Источник: router.route-map.name. |
|
status string |
Состояние. Варианты:
|
|
tag integer |
Значение тега. |
|
restart_mode string |
Режим перезапуска OSPF (graceful или LLS). Варианты:
|
|
restart_on_topology_change string |
Включение/отключение продолжения плавного перезапуска при изменении топологии. Варианты:
|
|
restart_period integer |
Период плавного перезапуска. |
|
rfc1583_compatible string |
Включение/отключение совместимости с RFC1583. Варианты:
|
|
router_id string |
Идентификатор маршрутизатора. |
|
spf_timers string |
Частота вычисления SPF. |
|
summary_address list / elements=dictionary |
Конфигурация сводных IP-адресов. |
|
advertise string |
Включение/отключение анонсирования. Варианты:
|
|
id integer / обязательный |
Идентификатор записи сводного адреса. См. <a href=’#notes’>Примечания</a>. |
|
prefix string |
Префикс. |
|
tag integer |
Значение тега. |
vdom string | Виртуальный домен из числа предварительно определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Устаревший fortiosapi снят с поддержки; предпочтительным способом запуска плейбуков является httpapi
- Модуль поддерживает check_mode.
Примеры
- name: Configure OSPF.
fortinet.fortios.fortios_router_ospf:
vdom: "{{ vdom }}"
router_ospf:
abr_type: "cisco"
area:
-
authentication: "none"
comments: "<your_own_value>"
default_cost: "10"
filter_list:
-
direction: "in"
id: "10"
list: "<your_own_value> (source router.access-list.name router.prefix-list.name)"
id: "12"
nssa_default_information_originate: "enable"
nssa_default_information_originate_metric: "10"
nssa_default_information_originate_metric_type: "1"
nssa_redistribution: "enable"
nssa_translator_role: "candidate"
range:
-
advertise: "disable"
id: "20"
prefix: "<your_own_value>"
substitute: "<your_own_value>"
substitute_status: "enable"
shortcut: "disable"
stub_type: "no-summary"
type: "regular"
virtual_link:
-
authentication: "none"
authentication_key: "<your_own_value>"
dead_interval: "40"
hello_interval: "10"
keychain: "<your_own_value> (source router.key-chain.name)"
md5_key: "<your_own_value>"
md5_keychain: "<your_own_value> (source router.key-chain.name)"
md5_keys:
-
id: "36"
key_string: "<your_own_value>"
name: "default_name_38"
peer: "<your_own_value>"
retransmit_interval: "5"
transmit_delay: "1"
auto_cost_ref_bandwidth: "1000"
bfd: "enable"
database_overflow: "enable"
database_overflow_max_lsas: "10000"
database_overflow_time_to_recover: "300"
default_information_metric: "10"
default_information_metric_type: "1"
default_information_originate: "enable"
default_information_route_map: "<your_own_value> (source router.route-map.name)"
default_metric: "10"
distance: "110"
distance_external: "110"
distance_inter_area: "110"
distance_intra_area: "110"
distribute_list:
-
access_list: "<your_own_value> (source router.access-list.name)"
id: "58"
protocol: "connected"
distribute_list_in: "<your_own_value> (source router.access-list.name router.prefix-list.name)"
distribute_route_map_in: "<your_own_value> (source router.route-map.name)"
log_neighbour_changes: "enable"
lsa_refresh_interval: "5"
neighbor:
-
cost: "0"
id: "66"
ip: "<your_own_value>"
poll_interval: "10"
priority: "1"
network:
-
area: "<your_own_value>"
comments: "<your_own_value>"
id: "73"
prefix: "<your_own_value>"
ospf_interface:
-
authentication: "none"
authentication_key: "<your_own_value>"
bfd: "global"
comments: "<your_own_value>"
cost: "0"
database_filter_out: "enable"
dead_interval: "0"
hello_interval: "0"
hello_multiplier: "0"
interface: "<your_own_value> (source system.interface.name)"
ip: "<your_own_value>"
keychain: "<your_own_value> (source router.key-chain.name)"
linkdown_fast_failover: "enable"
md5_key: "<your_own_value>"
md5_keychain: "<your_own_value> (source router.key-chain.name)"
md5_keys:
-
id: "92"
key_string: "<your_own_value>"
mtu: "0"
mtu_ignore: "enable"
name: "default_name_96"
network_type: "broadcast"
prefix_length: "0"
priority: "1"
resync_timeout: "40"
retransmit_interval: "5"
status: "disable"
transmit_delay: "1"
passive_interface:
-
name: "default_name_105 (source system.interface.name)"
redistribute:
-
metric: "0"
metric_type: "1"
name: "default_name_109"
routemap: "<your_own_value> (source router.route-map.name)"
status: "enable"
tag: "0"
restart_mode: "none"
restart_on_topology_change: "enable"
restart_period: "120"
rfc1583_compatible: "enable"
router_id: "<your_own_value>"
spf_timers: "<your_own_value>"
summary_address:
-
advertise: "disable"
id: "121"
prefix: "<your_own_value>"
tag: "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_ospf_module.html