Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_router_route_map — настройка карт маршрутизации в 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_route_map.

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

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

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

  • Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), устанавливая и изменяя параметры функции маршрутизатора и категории route_map. Перед использованием необходимо настроить все параметры и значения примеров в соответствии с источниками данных. Проверено на 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"

router_route_map

dictionary

Настройка карт маршрутизации.

comments

string

Необязательные комментарии.

name

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

Имя.

rule

list / elements=dictionary

Правило.

action

string

Действие.

Варианты:

  • "permit"
  • "deny"

id

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

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

match_as_path

string

Сопоставить со списком путей AS BGP. Источник: router.aspath-list.name.

match_community

string

Сопоставить со списком сообществ BGP. Источник: router.community-list.name.

match_community_exact

string

Включить или отключить точное сопоставление сообществ.

Варианты:

  • "enable"
  • "disable"

match_extcommunity

string

Сопоставить со списком расширенных сообществ BGP. Источник: router.extcommunity-list.name.

match_extcommunity_exact

string

Включить или отключить точное сопоставление расширенных сообществ.

Варианты:

  • "enable"
  • "disable"

match_flags

integer

Значение флагов BGP для сопоставления (0–65535)

match_interface

string

Сопоставить с конфигурацией интерфейса. Источник: system.interface.name.

match_ip6_address

string

Сопоставить с адресом IPv6, разрешенным access-list6 или prefix-list6. Источники: router.access-list6.name, router.prefix-list6.name.

match_ip6_nexthop

string

Сопоставить с адресом следующего узла IPv6, переданным access-list6 или prefix-list6. Источники: router.access-list6.name, router.prefix-list6.name.

match_ip_address

string

Сопоставить с IP-адресом, разрешенным access-list или prefix-list. Источники: router.access-list.name, router.prefix-list.name.

match_ip_nexthop

string

Сопоставить с IP-адресом следующего узла, переданным access-list или prefix-list. Источники: router.access-list.name, router.prefix-list.name.

match_metric

integer

Сопоставить метрику для перераспределяемых маршрутов.

match_origin

string

Сопоставить код источника BGP.

Варианты:

  • "none"
  • "egp"
  • "igp"
  • "incomplete"

match_route_type

string

Сопоставить тип маршрута.

Варианты:

  • "external-type1"
  • "external-type2"
  • "none"
  • "1"
  • "2"

match_suppress

string

Включить или отключить сопоставление с подавленным исходным соседом.

Варианты:

  • "enable"
  • "disable"

match_tag

integer

Сопоставить тег.

match_vrf

integer

Сопоставить идентификатор VRF.

set_aggregator_as

integer

AS агрегатора BGP.

set_aggregator_ip

string

IP-адрес агрегатора BGP.

set_aspath

list / elements=dictionary

Добавить в начало атрибут пути AS BGP.

as

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

Номер AS (0–4294967295). Повторяющиеся номера указывайте в кавычках, например «1 1 2».

set_aspath_action

string

Указать предпочтительное действие set-aspath.

Варианты:

  • "prepend"
  • "replace"

set_atomic_aggregate

string

Включить или отключить атрибут atomic aggregate BGP.

Варианты:

  • "enable"
  • "disable"

set_community

list / elements=dictionary

Атрибут сообщества BGP.

community

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

Атрибут: AA|AA:NN|internet|local-AS|no-advertise|no-export (для известных сообществ требуется точное совпадение).

set_community_additive

string

Включить или отключить добавление set-community к существующему сообществу.

Варианты:

  • "enable"
  • "disable"

set_community_delete

string

Удалить сообщества, соответствующие списку сообществ. Источник: router.community-list.name.

set_dampening_max_suppress

integer

Максимальная длительность подавления маршрута (1–255 мин, 0 = не задано).

set_dampening_reachability_half_life

integer

Период полураспада штрафа при достижимости (1–45 мин, 0 = не задано).

set_dampening_reuse

integer

Значение, при котором начинается повторное использование маршрута (1–20000, 0 = не задано).

set_dampening_suppress

integer

Значение, при котором начинается подавление маршрута (1–20000, 0 = не задано).

set_dampening_unreachability_half_life

integer

Период полураспада штрафа при недостижимости (1–45 мин, 0 = не задано).

set_extcommunity_rt

list / elements=dictionary

Расширенное сообщество Route Target.

community

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

AA:NN.

set_extcommunity_soo

list / elements=dictionary

Расширенное сообщество Site-of-Origin.

community

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

Сообщество (формат = AA:NN).

set_flags

integer

Значение флагов BGP (0–65535)

set_ip6_nexthop

string

Глобальный адрес IPv6 следующего узла.

set_ip6_nexthop_local

string

Локальный адрес IPv6 следующего узла.

set_ip_nexthop

string

IP-адрес следующего узла.

set_ip_prefsrc

string

IP-адрес предпочтительного источника.

set_local_preference

integer

Атрибут пути локального предпочтения BGP.

set_metric

integer

Значение метрики.

set_metric_type

string

Тип метрики.

Варианты:

  • "external-type1"
  • "external-type2"
  • "none"
  • "1"
  • "2"

set_origin

string

Код источника BGP.

Варианты:

  • "none"
  • "egp"
  • "igp"
  • "incomplete"

set_originator_id

string

Атрибут идентификатора инициатора BGP.

set_priority

integer

Приоритет для таблицы маршрутизации.

set_route_tag

integer

Тег маршрута для таблицы маршрутизации.

set_tag

integer

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

set_vpnv4_nexthop

string

IP-адрес следующего узла VPNv4.

set_vpnv6_nexthop

string

Глобальный адрес IPv6 следующего узла VPNv6.

set_vpnv6_nexthop_local

string

Локальный для канала адрес IPv6 следующего узла VPNv6.

set_weight

integer

Вес BGP для таблицы маршрутизации.

state

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

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

Варианты:

  • "present"
  • "absent"

vdom

string

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

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

Примечания

Примечание

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

Примеры

- name: Configure route maps.
  fortinet.fortios.fortios_router_route_map:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      router_route_map:
          comments: "<your_own_value>"
          name: "default_name_4"
          rule:
              -
                  action: "permit"
                  id: "7"
                  match_as_path: "<your_own_value> (source router.aspath-list.name)"
                  match_community: "<your_own_value> (source router.community-list.name)"
                  match_community_exact: "enable"
                  match_extcommunity: "<your_own_value> (source router.extcommunity-list.name)"
                  match_extcommunity_exact: "enable"
                  match_flags: "32767"
                  match_interface: "<your_own_value> (source system.interface.name)"
                  match_ip_address: "<your_own_value> (source router.access-list.name router.prefix-list.name)"
                  match_ip_nexthop: "<your_own_value> (source router.access-list.name router.prefix-list.name)"
                  match_ip6_address: "<your_own_value> (source router.access-list6.name router.prefix-list6.name)"
                  match_ip6_nexthop: "<your_own_value> (source router.access-list6.name router.prefix-list6.name)"
                  match_metric: ""
                  match_origin: "none"
                  match_route_type: "external-type1"
                  match_suppress: "enable"
                  match_tag: ""
                  match_vrf: ""
                  set_aggregator_as: "0"
                  set_aggregator_ip: "<your_own_value>"
                  set_aspath:
                      -
                          as: "<your_own_value>"
                  set_aspath_action: "prepend"
                  set_atomic_aggregate: "enable"
                  set_community:
                      -
                          community: "<your_own_value>"
                  set_community_additive: "enable"
                  set_community_delete: "<your_own_value> (source router.community-list.name)"
                  set_dampening_max_suppress: "0"
                  set_dampening_reachability_half_life: "0"
                  set_dampening_reuse: "0"
                  set_dampening_suppress: "0"
                  set_dampening_unreachability_half_life: "0"
                  set_extcommunity_rt:
                      -
                          community: "<your_own_value>"
                  set_extcommunity_soo:
                      -
                          community: "<your_own_value>"
                  set_flags: "32767"
                  set_ip_nexthop: "<your_own_value>"
                  set_ip_prefsrc: "<your_own_value>"
                  set_ip6_nexthop: "<your_own_value>"
                  set_ip6_nexthop_local: "<your_own_value>"
                  set_local_preference: ""
                  set_metric: ""
                  set_metric_type: "external-type1"
                  set_origin: "none"
                  set_originator_id: "<your_own_value>"
                  set_priority: ""
                  set_route_tag: ""
                  set_tag: ""
                  set_vpnv4_nexthop: "<your_own_value>"
                  set_vpnv6_nexthop: "<your_own_value>"
                  set_vpnv6_nexthop_local: "<your_own_value>"
                  set_weight: ""

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

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

Ключ

Описание

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_router_route_map_module.html

Spec-Zone.ru

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