Модуль cisco.iosxr.iosxr_bgp_address_family — модуль ресурсов для настройки семейства адресов BGP.

Примечание

Этот модуль входит в коллекцию cisco.iosxr (версия 12.3.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.iosxr.

Чтобы использовать модуль в плейбуке, укажите: cisco.iosxr.iosxr_bgp_address_family.

Добавлено в cisco.iosxr 2.0.0

Краткое описание
Параметры
Примечания
Примеры

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

Этот модуль настраивает атрибуты семейства адресов BGP на платформах Cisco IOS-XR и управляет ими.

Примечание

Для этого модуля имеется соответствующий модуль действий.

Псевдонимы: bgp_address_family

Параметры

Параметр	Комментарии
config dictionary	Список конфигураций семейства адресов BGP.
address_family list / elements=dictionary	Включить семейство адресов и перейти в режим его настройки
additional_paths string	Команды BGP additional-paths Варианты: `"send"` `"receive"`
advertise_best_external boolean	Анонсировать наилучший внешний путь. Варианты: `false` `true`
afi string	Семейство адресов. Варианты: `"ipv4"` `"ipv6"` `"l2vpn"` `"link-state"` `"vpnv4"` `"vpnv6"`
aggregate_address list / elements=dictionary	Настройка агрегированных записей BGP.
as_confed_set boolean	Формировать сведения о пути AS confed set. Варианты: `false` `true`
as_set boolean	Формировать сведения о пути AS set. Варианты: `false` `true`
route_policy string	Политика для управления анонсированием, подавлением и атрибутами.
summary_only boolean	Фильтровать из обновлений более специфичные маршруты. Варианты: `false` `true`
value string	Агрегированный адрес IPv4 и маска или длина маски.
allocate_label dictionary	Назначать метки.
all boolean	Назначать метки всем префиксам. Варианты: `false` `true`
route_policy string	Использовать политику маршрутизации для выбора префиксов, которым будут назначены метки.
allow_vpn_default_originate boolean	Разрешить отправку маршрута default originate соседу VPN. Варианты: `false` `true`
as_path_loopcheck_out_disable boolean	Настроить проверку циклов AS Path для исходящих обновлений. Варианты: `false` `true`
bgp dictionary	Команды BGP.
attribute_download boolean	Настроить загрузку атрибутов для этого семейства адресов. Варианты: `false` `true`
bestpath dictionary	Изменить критерии выбора маршрута по умолчанию.
origin_as dictionary	Параметры origin-AS BGP.
allow dictionary	Параметры origin-AS BGP.
invalid boolean	При выборе наилучшего пути BGP разрешать недопустимый origin-AS Варианты: `false` `true`
use dictionary	Параметры origin-AS BGP.
validity boolean	При выборе наилучшего пути BGP учитывать достоверность origin-AS Варианты: `false` `true`
client_to_client dictionary	Настроить отражение маршрутов между клиентами.
reflection dictionary	Отключить отражение cluster ID между клиентами.
cluster_id_disable dictionary	ID кластера, для которого нужно отключить отражение.
cluster_id string	ID кластера, для которого нужно отключить отражение.
disable boolean	Отключить ID кластера. Варианты: `false` `true`
disable boolean	Отключить отражение. Варианты: `false` `true`
dampening dictionary	Включить подавление частых изменений маршрутов
route_policy string	Политика маршрутизации для задания критериев подавления.
set boolean	Включить подавление. Варианты: `false` `true`
value integer	Период полураспада штрафа
import_delay dictionary	Задать задержку для пакетной обработки импорта.
delay_ms_parts integer	Часть задержки в миллисекундах <0-999>.
delay_second_parts integer	Задержка, часть в секундах <0-10>.
label_delay dictionary	Задать задержку для пакетной обработки меток
delay_ms_parts integer	Часть задержки в миллисекундах <0-999>.
delay_second_parts integer	Задержка, часть в секундах <0-10>.
origin_as dictionary	Параметры origin-AS BGP.
validation dictionary	Параметры проверки origin-AS BGP.
disable boolean	Отключить проверку origin-AS с помощью RPKI. Варианты: `false` `true`
signal dictionary	Передавать соседям сведения о достоверности origin-AS.
ibgp boolean	Передавать сведения о достоверности origin-AS соседям iBGP Варианты: `false` `true`
scan_time integer	Настроить интервал фонового сканирования для этого семейства адресов. Пример: <5-3600>.
default_martian_check_disable boolean	Проверка недопустимых адресов по умолчанию Варианты: `false` `true`
distance dictionary	Задать административное расстояние.
local_routes integer	Расстояние для локальных маршрутов <1-255>.
routes_external_to_as integer	Расстояние для маршрутов, внешних по отношению к AS <1-255>.
routes_internal_to_as integer	Расстояние для маршрутов, внутренних по отношению к AS <1-255>.
dynamic_med integer	Интервал динамического MED.
global_table_multicast boolean	Включить многоадресную рассылку в глобальной таблице. Варианты: `false` `true`
inter_as_install boolean	Устанавливать удалённые маршруты MVPN в VRF по умолчанию. Применимо для AFI MVPN. Варианты: `false` `true`
label_mode dictionary	Настройка меток.
per_ce boolean	Задать режим меток для каждого CE Варианты: `false` `true`
per_prefix boolean	Задать режим меток для каждого префикса. Варианты: `false` `true`
per_vrf boolean	Задать режим меток для каждого VRF. Варианты: `false` `true`
route_policy string	Использовать политику маршрутизации для выбора префиксов в режиме назначения меток.
maximum_paths dictionary	Передавать пакеты по нескольким путям.
ebgp dictionary	Многопутевая маршрутизация eBGP.

max_path_value integer	<2-64> Количество путей (ограничение включает резервный путь).
order_igp_metric boolean	Упорядочивать альтернативные пути-кандидаты для выбора согласно настроенному количеству (поддержка Cisco). Варианты: `false` `true`
selective_order_igp_metric boolean	Разрешить альтернативные пути только от отмеченных соседей Варианты: `false` `true`
eibgp dictionary	Многопутевая маршрутизация eiBGP.
max_path_value integer	<2-64> Количество путей (ограничение включает резервный путь).
order_igp_metric boolean	Упорядочивать альтернативные пути-кандидаты для выбора согласно настроенному количеству (поддержка Cisco). Варианты: `false` `true`
selective_order_igp_metric boolean	Разрешить альтернативные пути только от отмеченных соседей Варианты: `false` `true`
ibgp dictionary	Многопутевая маршрутизация iBGP.
max_path_value integer	<2-64> Количество путей (ограничение включает резервный путь).
order_igp_metric boolean	Упорядочивать альтернативные пути-кандидаты для выбора согласно настроенному количеству (поддержка Cisco). Варианты: `false` `true`
selective_order_igp_metric boolean	Разрешить альтернативные пути только от отмеченных соседей Варианты: `false` `true`
unequal_cost dictionary	Разрешить использование альтернативных путей с разными метриками IGP для следующего перехода BGP.
order_igp_metric boolean	Упорядочивать альтернативные пути-кандидаты для выбора согласно настроенному количеству (поддержка Cisco). Варианты: `false` `true`
selective_order_igp_metric boolean	Разрешить альтернативные пути только от отмеченных соседей Варианты: `false` `true`
set boolean	Установить unequal_cost. Варианты: `false` `true`
mvpn_single_forwarder_selection_all boolean	Включить выбор единственного перенаправителя для всех Варианты: `false` `true`
mvpn_single_forwarder_selection_highest_ip_address boolean	Включить выбор единственного перенаправителя для PE с наибольшим IP-адресом. Варианты: `false` `true`
networks list / elements=dictionary	Указать сеть для анонсирования через BGP.
backdoor_route_policy string	Указать резервный маршрут BGP.
network string	Указать сеть для анонсирования через BGP.
route_policy string	Политика маршрутизации для изменения атрибутов.
nexthop dictionary	Следующий переход
resolution_prefix_length_minimum integer	Задать минимальную длину префикса для разрешения следующего перехода. Варианты: `0` `32`
route_policy string	Политика для фильтрации уведомлений о следующем переходе.
trigger_delay_critical integer	Для критических уведомлений
trigger_delay_non_critical integer	Для некритических уведомлений.
optimal_route_reflection dictionary	Настроить группу оптимального отражения маршрутов.
group_name string	Имя группы ORR — не более 32 символов.
primary_address string	Основной IPv4-адрес.
secondary_address string	Вторичный IPv4-адрес
permanent_network_route_policy string	Имя политики.
redistribute list / elements=dictionary	Распространять информацию из другого протокола маршрутизации.
external boolean	Распространять внешние маршруты EIGRP. Применимо для EIGRP. Варианты: `false` `true`
external_ospf integer	Распространять внешние маршруты OSPF. Применимо для OSPF. Варианты: `1` `2`
id string	Идентификатор протокола маршрутизации для настройки распространения информации. Примеры: имя приложения, имя экземпляра EIGRP/IS-IS, тег OSPF Допустимо для протоколов ‘ospf’, ‘eigrp’, ‘isis’ и ‘application’.
internal boolean	Распространять внутренние маршруты EIGRP. Применимо для EIGRP. Варианты: `false` `true`
level string	Распространять маршруты с указанных уровней ISIS. Распространять маршруты ISIS уровня 1 Распространять межзональные маршруты ISIS уровня 1 Распространять маршруты ISIS уровня 2 Варианты: `"1"` `"2"` `"1-inter-area"`
metric integer	Задает метрику для распространяемых маршрутов.
nssa_external boolean	Распространять внешние маршруты NSSA OSPF. Применимо для OSPF. Варианты: `false` `true`
protocol string / обязательный	Указывает протокол для настройки распространения информации. Варианты: `"ospf"` `"application"` `"eigrp"` `"isis"` `"static"` `"connected"` `"lisp"` `"mobile"` `"rip"` `"subscriber"`
route_policy string	Указывает ссылку на политику маршрутизации.
retain_local_label integer	Время хранения метки в минутах <3-60>.
route_target_download boolean	Установка целевого идентификатора маршрута в RIB. Варианты: `false` `true`
safi string	Модификатор семейства адресов Варианты: `"flowspec"` `"mdt"` `"multicast"` `"mvpn"` `"rt-filter"` `"tunnel"` `"unicast"` `"evpn"` `"mspw"` `"vpls-vpws"` `"link-state"`
segmented_multicast boolean	Включить сегментированную многоадресную рассылку. Применимо для AFI MVPN. Варианты: `false` `true`
table_policy string	Настроить политику установки маршрутов в RIB.
update dictionary	Настройка формирования обновлений BGP.
limit dictionary	Ограничение обновлений.
address_family integer	Ограничение обновлений для подгрупп.
sub_group dictionary	Ограничение обновлений для семейства адресов.
ebgp integer	Ограничение обновлений для подгрупп eBGP <1-512.
ibgp integer	Ограничение обновлений для подгрупп iBGP <1-512.
wait_install boolean	Ожидать установки маршрута. Варианты: `false` `true`
vrf string	Имя VRF.
vrf_all_conf dictionary	Конфигурация применяется ко всем VRF и предназначена для AFI VPNv6 и модификатора unicast.
label_mode dictionary	Настройка меток.
per_ce boolean	Установить режим меток для каждого CE Варианты: `false` `true`

per_vrf boolean	Задать режим меток per VRF. Варианты: `false` `true`
route_policy string	Использовать политику маршрутизации для выбора префиксов в режиме выделения меток.
source_rt_import_policy boolean	Получать целевые значения импорта маршрутов из import-policy. Варианты: `false` `true`
table_policy string	Настроить политику установки маршрутов в RIB.
weight dictionary	Определить или изменить вес.
reset_on_import boolean	Установить reset_on_import. Варианты: `false` `true`
reset_on_import_disable boolean	Отключить reset_on_import. Варианты: `false` `true`
as_number string	Номер автономной системы.
running_config string	Этот параметр используется только при состоянии parsed. Значением этого параметра должен быть вывод, полученный с устройства IOS XR при выполнении команды show running-config router bgp. Состояние parsed считывает конфигурацию из параметра `running_config` и преобразует её в структурированные данные Ansible согласно спецификации аргументов модуля ресурса, после чего значение возвращается в ключе parsed результата.
state string	Состояние, в котором должна остаться конфигурация. Варианты: `"deleted"` `"merged"` ← (по умолчанию) `"overridden"` `"replaced"` `"gathered"` `"rendered"` `"parsed"`

Примечания

Примечание

Этот модуль работает с подключением network_cli.

Примеры

# Using merged
# Before state:
# -------------
# RP/0/0/CPU0:iosxr-02#show running-config router bgp
# Sat Feb 20 03:49:43.618 UTC
# router bgp 65536
#  bgp router-id 192.0.2.1
#  address-family vpnv4 unicast
#  vrf vrf1
#   rd auto
- name: Merge the provided configuration with the existing running configuration
  cisco.iosxr.iosxr_bgp_address_family:
    state: merged
    config:
      as_number: '65536'
      address_family:
        - afi: ipv4
          safi: unicast
          vrf: vrf1
          dynamic_med: 9
          redistribute:
            - protocol: connected
              metric: 10
        - afi: ipv4
          safi: unicast
          dynamic_med: 10
          redistribute:
            - protocol: application
              id: test1
              metric: 10
          bgp:
            scan_time: 20
            attribute_download: true
          advertise_best_external: true
          allocate_label:
            all: true
# Task output
# -------------
# commands:
# - router bgp 65536
# - address-family ipv4 unicast
# - advertise best-external
# - allocate-label all
# - bgp attribute-download
# - bgp scan-time 20
# - dynamic-med interval 10
# - redistribute application test1 metric 10
# - vrf vrf1
# - address-family ipv4 unicast
# - dynamic-med interval 9
# - redistribute connected metric 10
#
#
# after:
#   as_number: "65536"
#   address_family:
#     - afi: "ipv4"
#       safi: "unicast"
#       vrf: vrf1
#       dynamic_med: 9
#       redistribute:
#         - protocol: connected
#           metric: 10
#     - afi: "ipv4"
#       safi: "unicast"
#       dynamic_med: 10
#       redistribute:
#         - protocol: application
#           id: "test1"
#           metric: 10
#       bgp:
#         scan_time: 20
#         attribute_download: true
#       advertise_best_external: true
#       allocate_label:
#         all: true
#
# After state:
# -------------
# RP/0/0/CPU0:iosxr-02#show running-config router bgp
# Sat Feb 20 03:49:43.618 UTC
# router bgp 65536
#  bgp router-id 192.0.1.1
#  address-family ipv4 unicast
#    advertise best-external
#    allocate-label all
#    bgp attribute-download
#    bgp scan-time 20
#  address-family vpnv4 unicast
#  vrf vrf1
#   rd auto
#   address-family ipv4 unicast
#     dynamic-med interval 9
#     redistribute connected metric 10
#
# Using replaced
# Before state:
# -------------
# RP/0/0/CPU0:iosxr-02#show running-config router bgp
# Sat Feb 20 03:49:43.618 UTC
# router bgp 65536
#  bgp router-id 192.0.1.1
#  address-family ipv4 unicast
#    advertise best-external
#    allocate-label all
#    bgp attribute-download
#    bgp scan-time 20
#  address-family vpnv4 unicast
#  vrf vrf1
#   rd auto
#   address-family ipv4 unicast
#     dynamic-med interval 9
#     redistribute connected metric 10
#
#
- name: Replace the provided configuration with the existing running configuration
  cisco.iosxr.iosxr_bgp_address_family:
    state: replaced
    config:
      as_number: '65536'
      address_family:
        - afi: ipv4
          safi: unicast
          vrf: vrf1
          dynamic_med: 10
# Task output
# -------------
# commands:
# - router bgp 65536
# - vrf vrf1
# - address-family ipv4 unicast
# - dynamic-med interval 10
# - no redistribute connected metric 10
#
# after:
#   as_number: "65536"
#   address_family:
#     - afi: "ipv4"
#       safi: "unicast"
#       vrf: vrf1
#       dynamic_med: 10
#     - afi: "ipv4"
#       safi: "unicast"
#       dynamic_med: 10
#       redistribute:
#         - protocol: application
#           id: "test1"
#           metric: 10
#       bgp:
#         scan_time: 20
#         attribute_download: true
#       advertise_best_external: true
#       allocate_label:
#         all: true
# After state:
# -------------
# RP/0/0/CPU0:iosxr-02#show running-config router bgp
# Sat Feb 20 03:49:43.618 UTC
# router bgp 65536
#  bgp router-id 192.0.1.1
#  address-family ipv4 unicast
#    advertise best-external
#    allocate-label all
#    bgp attribute-download
#    bgp scan-time 20
#  address-family vpnv4 unicast
#  vrf vrf1
#   rd auto
#   address-family ipv4 unicast
#     dynamic-med interval 10
#
#
# Using overridden
# Before state:
# -------------
# RP/0/0/CPU0:iosxr-02#show running-config router bgp
# Sat Feb 20 03:49:43.618 UTC
# router bgp 65536
#  bgp router-id 192.0.1.1
#  address-family ipv4 unicast
#    advertise best-external
#    allocate-label all
#    bgp attribute-download
#    bgp scan-time 20
#  address-family vpnv4 unicast
#  vrf vrf1
#   rd auto
#   address-family ipv4 unicast
#     dynamic-med interval 9
#     redistribute connected metric 10
#
#
- name: Override the provided configuration with the existing running configuration
  cisco.iosxr.iosxr_bgp_address_family:
    state: overridden
    config:
      as_number: '65536'
      address_family:
        - afi: ipv4
          safi: unicast
          vrf: vrf1
          dynamic_med: 10

# Task output
# -------------
# commands:
# - router bgp 65536
# - no address-family ipv4 unicast
# - vrf vrf1
# - address-family ipv4 unicast
# - dynamic-med interval 10
# - no redistribute connected metric 10
#
#
# after:
#   as_number: "65536"
#   address_family:
#     - afi: "ipv4"
#       safi: "unicast"
#       vrf: vrf1
#       dynamic_med: 10
#
# After state:
# -------------
# RP/0/0/CPU0:iosxr-02#show running-config router bgp
# Sat Feb 20 03:49:43.618 UTC
# router bgp 65536
#  bgp router-id 192.0.1.1
#  address-family vpnv4 unicast
#  vrf vrf1
#   rd auto
#   address-family ipv4 unicast
#     dynamic-med interval 10
#
#
# Using deleted
# Before state:
# -------------
# RP/0/0/CPU0:iosxr-02#show running-config router bgp
# Sat Feb 20 03:49:43.618 UTC
# router bgp 65536
#  bgp router-id 192.0.1.1
#  address-family ipv4 unicast
#    advertise best-external
#    allocate-label all
#    bgp attribute-download
#    bgp scan-time 20
#  address-family vpnv4 unicast
#  vrf vrf1
#   rd auto
#   address-family ipv4 unicast
#     dynamic-med interval 9
#     redistribute connected metric 10
#
#
- name: Delete the provided configuration
  cisco.iosxr.iosxr_bgp_address_family:
    state: deleted
    config:

# Task output
# -------------
# commands:
# - router bgp 65536
# - no address-family ipv4 unicast
# - vrf vrf1
# - no address-family ipv4 unicast
#
#
# after:
#   as_number: "65536"
#
#
# After state:
# -------------
# RP/0/0/CPU0:iosxr-02#show running-config router bgp
# Sat Feb 20 03:49:43.618 UTC
# router bgp 65536
#  bgp router-id 192.0.1.1
#  address-family vpnv4 unicast
#  vrf vrf1
#   rd auto
#
# Using rendered
# -------------
#
- name: rendered state example
  cisco.iosxr.iosxr_bgp_address_family:
    state: rendered
    config:
      as_number: '65536'
      address_family:
        - afi: ipv4
          safi: unicast
          vrf: vrf1
          dynamic_med: 9
          redistribute:
            - protocol: connected
              metric: 10
        - afi: ipv4
          safi: unicast
          dynamic_med: 10
          redistribute:
            - protocol: application
              id: test1
              metric: 10
          bgp:
            scan_time: 20
            attribute_download: true
          advertise_best_external: true
          allocate_label:
            all: true
# Task output
# -------------
# commands:
# - router bgp 65536
# - address-family ipv4 unicast
# - advertise best-external
# - allocate-label all
# - bgp attribute-download
# - bgp scan-time 20
# - dynamic-med interval 10
# - redistribute application test1 metric 10
# - vrf vrf1
# - address-family ipv4 unicast
# - dynamic-med interval 9
# - redistribute connected metric 10
#
# Using gathered
# -------------
- name: Gather existing running configuration
  cisco.iosxr.iosxr_bgp_address_family:
    state: gathered
    config:
      as_number: '65536'
      address_family:
        - afi: ipv4
          safi: unicast
          vrf: vrf1
          dynamic_med: 9
          redistribute:
            - protocol: connected
              metric: 10
        - afi: ipv4
          safi: unicast
          dynamic_med: 10
          redistribute:
            - protocol: application
              id: test1
              metric: 10
          bgp:
            scan_time: 20
            attribute_download: true
          advertise_best_external: true
          allocate_label:
            all: true
# gathered:
#   as_number: "65536"
#   address_family:
#     - afi: "ipv4"
#       safi: "unicast"
#       vrf: vrf1
#       dynamic_med: 9
#       redistribute:
#         - protocol: connected
#           metric: 10
#     - afi: "ipv4"
#       safi: "unicast"
#       dynamic_med: 10
#       redistribute:
#         - protocol: application
#           id: "test1"
#           metric: 10
#       bgp:
#         scan_time: 20
#         attribute_download: true
#       advertise_best_external: true
#       allocate_label:
#         all: true
#
# Using parsed
#
# parsed.cfg
# ------------
# router bgp 65536
#  bgp router-id 192.0.1.1
#  address-family ipv4 unicast
#    advertise best-external
#    allocate-label all
#    bgp attribute-download
#    bgp scan-time 20
#  address-family vpnv4 unicast
#  vrf vrf1
#   rd auto
#   address-family ipv4 unicast
#     dynamic-med interval 9
#     redistribute connected metric 10
#
- name: Parse externally provided BGP neighbor AF config
  cisco.iosxr.iosxr_bgp_address_family:
    running_config: "{{ lookup('file', 'parsed.cfg') }}"
    state: parsed

# Task output (redacted)
# -----------------------
# parsed:
#   as_number: "65536"
#   address_family:
#     - afi: "ipv4"
#       safi: "unicast"
#       vrf: vrf1
#       dynamic_med: 9
#       redistribute:
#         - protocol: connected
#           metric: 10
#     - afi: "ipv4"
#       safi: "unicast"
#       dynamic_med: 10
#       redistribute:
#         - protocol: application
#           id: "test1"
#           metric: 10
#       bgp:
#         scan_time: 20
#         attribute_download: true
#       advertise_best_external: true
#       allocate_label:
#         all: true

Авторы

Ashwini Mhatre (@amhatre)

Ссылки на коллекцию

© 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/cisco/iosxr/iosxr_bgp_address_family_module.html