Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_router_ospf — Настройка OSPF на устройствах FortiOS и FortiGate.

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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.15

Параметры

Параметр

Комментарии

access_token

string

Токенная аутентификация. Генерируется из GUI Fortigate.

enable_log

boolean

Включить/Выключить логирование для задачи.

Варианты:

  • false ← (default)
  • true

member_path

string

Путь к атрибуту члена для операции.

Разделяется символом слеша, если атрибутов более одного.

Параметр, помеченный как member_path, является допустимым для выполнения операции с членом.

member_state

string

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

При указании member_state опция state игнорируется.

Варианты:

  • "present"
  • "absent"

router_ospf

dictionary

Настроить OSPF.

abr_type

string

Тип пограничного маршрутизатора области.

Варианты:

  • "cisco"
  • "ibm"
  • "shortcut"
  • "standard"

area

list / elements=dictionary

Конфигурация области OSPF.

authentication

string

Тип аутентификации.

Варианты:

  • "none"
  • "text"
  • "message-digest"
  • "md5"

comments

string

Комментарий.

default_cost

integer

Резюмирующая стоимость по умолчанию для stub или NSSA области.

filter_list

list / elements=dictionary

Конфигурация списка фильтров области OSPF.

direction

string

Направление.

Варианты:

  • "in"
  • "out"

id

integer / required

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

list

string

Имя списка доступа или списка префиксов. Источник router.access-list.name router.prefix-list.name.

id

string / required

IP-адрес записи области.

nssa_default_information_originate

string

Перераспределить, объявить или не генерировать маршрут по умолчанию типа 7 в область NSSA.

Варианты:

  • "enable"
  • "always"
  • "disable"

nssa_default_information_originate_metric

integer

Метрика OSPF по умолчанию.

nssa_default_information_originate_metric_type

string

Тип метрики OSPF для маршрутов по умолчанию.

Варианты:

  • "1"
  • "2"

nssa_redistribution

string

Включить/выключить перераспределение в область NSSA.

Варианты:

  • "enable"
  • "disable"

nssa_translator_role

string

Тип роли транслятора NSSA.

Варианты:

  • "candidate"
  • "never"
  • "always"

range

list / elements=dictionary

Конфигурация диапазона области OSPF.

advertise

string

Включить/выключить статус объявления.

Варианты:

  • "disable"
  • "enable"

id

integer / required

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

prefix

string

Префикс.

substitute

string

Замещающий префикс.

substitute_status

string

Включить/выключить статус замены.

Варианты:

  • "enable"
  • "disable"

shortcut

string

Включить/выключить опцию сокращения.

Варианты:

  • "disable"
  • "enable"
  • "default"

stub_type

string

Настройка сводки Stub.

Варианты:

  • "no-summary"
  • "summary"

type

string

Настройка типа области.

Варианты:

  • "regular"
  • "nssa"
  • "stub"

virtual_link

list / elements=dictionary

Конфигурация виртуальной ссылки OSPF.

authentication

string

Тип аутентификации.

Варианты:

  • "none"
  • "text"
  • "message-digest"
  • "md5"

authentication_key

string

Ключ аутентификации.

dead_interval

integer

Интервал ожидания.

hello_interval

integer

Интервал опроса.

keychain

string

Имя цепочки ключей Message-digest. Источник router.key-chain.name.

md5_key

string

Ключ MD5.

md5_keychain

string

Имя цепочки ключей аутентификации MD5. Источник router.key-chain.name.

md5_keys

list / elements=dictionary

Ключ MD5.

id

integer / required

Идентификатор ключа (1 - 255). См. <a href=’#notes’>Примечания</a>.

key_string

string

Пароль для ключа.

name

string / required

Имя записи виртуальной ссылки.

peer

string

IP-адрес пира.

retransmit_interval

integer

Интервал повторной передачи.

transmit_delay

integer

Задержка передачи.

auto_cost_ref_bandwidth

integer

Референтная пропускная способность в мегабитах в секунду.

bfd

string

Двунаправленная проверка пересылки (BFD).

Choices:

  • "enable"
  • "disable"

database_overflow

string

Включить/выключить переполнение базы данных.

Choices:

  • "enable"
  • "disable"

database_overflow_max_lsas

integer

Максимальное количество LSA при переполнении базы данных.

database_overflow_time_to_recover

integer

Время восстановления после переполнения базы данных (сек).

default_information_metric

integer

Метрика информации по умолчанию.

default_information_metric_type

string

Тип метрики информации по умолчанию.

Choices:

  • "1"
  • "2"

default_information_originate

string

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

Choices:

  • "enable"
  • "always"
  • "disable"

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 / required

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

protocol

string

Тип протокола.

Choices:

  • "connected"
  • "static"
  • "rip"

distribute_list_in

string

Фильтрация входящих маршрутов. Источник router.access-list.name router.prefix-list.name.

distribute_route_map_in

string

Фильтрация входящих внешних маршрутов с помощью карты маршрутов. Источник router.route-map.name.

log_neighbour_changes

string

Логирование изменений соседей OSPF.

Choices:

  • "enable"
  • "disable"

neighbor

list / elements=dictionary

Конфигурация соседа OSPF используется, когда OSPF работает в среде, отличной от широковещательной.

cost

integer

Стоимость интерфейса, значение в диапазоне от 0 до 65535, 0 означает автоматическую стоимость.

id

integer / required

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

ip

string

IP-адрес интерфейса соседа.

poll_interval

integer

Время интервала опроса в секундах.

priority

integer

Приоритет.

network

list / elements=dictionary

Конфигурация сети OSPF.

area

string

Подключить сеть к области.

comments

string

Комментарий.

id

integer / required

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

prefix

string

Префикс.

ospf_interface

list / elements=dictionary

Конфигурация интерфейса OSPF.

authentication

string

Тип аутентификации.

Варианты:

  • "none"
  • "text"
  • "message-digest"
  • "md5"

authentication_key

string

Ключ аутентификации.

bfd

string

Двунаправленное обнаружение пересылки (Bidirectional Forwarding Detection, BFD).

Варианты:

  • "global"
  • "enable"
  • "disable"

comments

string

Комментарий.

cost

integer

Стоимость интерфейса, значение в диапазоне от 0 до 65535, 0 означает автоматическую стоимость.

database_filter_out

string

Включить/отключить контроль за затоплением LSAs.

Варианты:

  • "enable"
  • "disable"

dead_interval

integer

Интервал отключения.

hello_interval

integer

Интервал приветствия.

hello_multiplier

integer

Количество пакетов приветствия в интервале отключения.

interface

string

Имя конфигурируемого интерфейса. Источник system.interface.name.

ip

string

IP-адрес.

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 / required

Идентификатор ключа (1 - 255). См. <a href=’#notes’>Примечания</a>.

key_string

string

Пароль для ключа.

mtu

integer

MTU для пакетов описания базы данных.

mtu_ignore

string

Включить/отключить игнорирование MTU.

Choices:

  • "enable"
  • "disable"

name

string / required

Имя записи интерфейса.

network_type

string

Тип сети.

Choices:

  • "broadcast"
  • "non-broadcast"
  • "point-to-point"
  • "point-to-multipoint"
  • "point-to-multipoint-non-broadcast"

prefix_length

integer

Длина префикса.

priority

integer

Приоритет.

resync_timeout

integer

Таймаут повторной синхронизации соседа с плавным перезапуском.

retransmit_interval

integer

Интервал повторной передачи.

status

string

Включить/отключить статус.

Choices:

  • "disable"
  • "enable"

transmit_delay

integer

Задержка передачи.

passive_interface

list / elements=dictionary

Конфигурация пассивного интерфейса.

name

string / required

Имя пассивного интерфейса. Источник system.interface.name.

redistribute

list / elements=dictionary

Конфигурация перераспределения.

metric

integer

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

metric_type

string

Тип метрики.

Choices:

  • "1"
  • "2"

name

string / required

Имя перераспределения.

routemap

string

Имя карты маршрутов. Источник router.route-map.name.

status

string

Статус.

Choices:

  • "enable"
  • "disable"

tag

integer

Значение тега.

restart_mode

string

Режим перезапуска OSPF (плавный или LLS).

Choices:

  • "none"
  • "lls"
  • "graceful-restart"

restart_on_topology_change

string

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

Choices:

  • "enable"
  • "disable"

restart_period

integer

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

rfc1583_compatible

string

Включить/отключить совместимость с RFC1583.

Варианты:

  • "enable"
  • "disable"

router_id

string

Идентификатор маршрутизатора.

spf_timers

string

Частота расчёта SPF.

summary_address

list / elements=dictionary

Настройка сводных адресов IP.

advertise

string

Включить/отключить рекламу статуса.

Варианты:

  • "disable"
  • "enable"

id

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

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

prefix

string

Префикс.

tag

integer

Значение тега.

vdom

string

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

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

Примечания

Примечание

  • Устаревший fortiosapi устарел, httpapi — предпочтительный способ запуска playbooks

Примеры

- 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"
          neighbor:
              -
                  cost: "0"
                  id: "65"
                  ip: "<your_own_value>"
                  poll_interval: "10"
                  priority: "1"
          network:
              -
                  area: "<your_own_value>"
                  comments: "<your_own_value>"
                  id: "72"
                  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)"
                  md5_key: "<your_own_value>"
                  md5_keychain: "<your_own_value> (source router.key-chain.name)"
                  md5_keys:
                      -
                          id: "90"
                          key_string: "<your_own_value>"
                  mtu: "0"
                  mtu_ignore: "enable"
                  name: "default_name_94"
                  network_type: "broadcast"
                  prefix_length: "0"
                  priority: "1"
                  resync_timeout: "40"
                  retransmit_interval: "5"
                  status: "disable"
                  transmit_delay: "1"
          passive_interface:
              -
                  name: "default_name_103 (source system.interface.name)"
          redistribute:
              -
                  metric: "0"
                  metric_type: "1"
                  name: "default_name_107"
                  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: "119"
                  prefix: "<your_own_value>"
                  tag: "0"

Значения возврата

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

Ключ

Описание

build

строка

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

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

Пример: "1547"

http_method

строка

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

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

Пример: "PUT"

http_status

строка

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

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

Пример: "200"

mkey

строка

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

Возвращается: успешно

Пример: "id"

name

строка

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

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

Пример: "urlfilter"

path

строка

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

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

Пример: "webfilter"

revision

строка

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

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

Пример: "17.0.2.10658"

serial

строка

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

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

Пример: "FGVMEVYYQT3AB5352"

status

строка

Указание результата операции

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

Пример: "success"

vdom

строка

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

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

Пример: "root"

version

строка

Версия 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_router_ospf_module.html

Spec-Zone.ru

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