Spec-Zone.ru › Ansible

Модуль cisco.iosxr.iosxr_bgp_templates — управление ресурсным модулем шаблонов BGP.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install cisco.iosxr.

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

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

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

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

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

Параметры

Параметр

Комментарии

config

dictionary

Конфигурации шаблонов BGP.

as_number

string

Номер автономной системы.

neighbor

list / elements=dictionary

Список конфигураций групп соседей BGP.

address_family

list / elements=dictionary

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

advertise

dictionary

Параметры анонсирования для каждого соседа

local_labeled_route

dictionary

Анонсирование маршрутов с локальной меткой

disable

boolean

Отключить local-labeled-route

Варианты:

  • false
  • true

set

boolean

Включить local-labeled-route

Варианты:

  • false
  • true

permanent_network

boolean

Разрешить постоянные сети для этого соседа

Варианты:

  • false
  • true

afi

string

Семейство адресов.

Варианты:

  • "ipv4"
  • "ipv6"
  • "vpnv4"
  • "vpnv6"
  • "link-state"
  • "l2vpn"

aigp

dictionary

Атрибут AIGP

disable

boolean

Игнорировать атрибут AIGP.

Варианты:

  • false
  • true

send_cost_community_disable

boolean

Отправлять атрибут AIGP.

Варианты:

  • false
  • true

send_med

dictionary

Параметры отправки MED.

disable

boolean

Отключить передачу значения AIGP в MED.

Варианты:

  • false
  • true

set

boolean

Включить передачу значения AIGP в MED.

Варианты:

  • false
  • true

set

boolean

Установить атрибут AIGP.

Варианты:

  • false
  • true

allowas_in

dictionary

Разрешить AS-путь, содержащий номер моей AS.

set

boolean

Включить allowas_in

Варианты:

  • false
  • true

value

integer

Количество вхождений номера AS: от 1 до 10.

as_override

dictionary

Заменять совпадающий номер AS при отправке обновления

inheritance_disable

boolean

Запретить наследование as-override от родительского объекта.

Варианты:

  • false
  • true

set

boolean

Включить as_override

Варианты:

  • false
  • true

bestpath_origin_as_allow_invalid

boolean

Изменить критерии выбора маршрута по умолчанию. Разрешить параметры origin-AS BGP.

Варианты:

  • false
  • true

capability_orf_prefix

string

Анонсировать этому соседу возможность ORF для префиксов адресов.

Варианты:

  • "both"
  • "send"
  • "none"
  • "receive"

default_originate

dictionary

Анонсировать этому соседу маршрут по умолчанию.

inheritance_disable

boolean

Запретить наследование default-originate от родительского объекта.

Варианты:

  • false
  • true

route_policy

string

Политика маршрутизации для задания критериев анонсирования маршрута по умолчанию

set

boolean

Установить маршрут по умолчанию.

Варианты:

  • false
  • true

encapsulation_type_srv6

boolean

Указать тип инкапсуляции

Варианты:

  • false
  • true

long_lived_graceful_restart

dictionary

Включить поддержку длительного graceful restart.

capable

boolean

Считать соседа поддерживающим LLGR.

Варианты:

  • false
  • true

stale_time

dictionary

Максимальное время ожидания перед удалением устаревших маршрутов длительного хранения.

accept

integer

Максимальное время приема

send

integer

Максимальное время отправки

maximum_prefix

dictionary

Максимальное количество префиксов, принимаемых от этого соседа.

discard_extra_paths

boolean

Отбрасывать дополнительные пути при превышении лимита.

Варианты:

  • false
  • true

max_limit

integer

Максимальное количество префиксов. <1-4294967295.

restart

integer

Интервал времени до перезапуска.

threshold_value

integer

Пороговое значение (%) для формирования предупреждения <1-100>.

warning_only

boolean

Выводить только предупреждение при превышении лимита.

Варианты:

  • false
  • true

multipath

boolean

Пути от этого соседа могут использоваться для многопутевой маршрутизации.

Варианты:

  • false
  • true

next_hop_self

dictionary

Отключить вычисление следующего перехода для этого соседа.

inheritance_disable

boolean

Запретить наследование next_hop_self от родительского объекта.

Варианты:

  • false
  • true

set

boolean

Установить next hop self.

Варианты:

  • false
  • true

next_hop_unchanged

dictionary

Отключить вычисление следующего перехода для этого соседа.

inheritance_disable

boolean

Запретить наследование next_hop_unchanged от родительского объекта.

Варианты:

  • false
  • true

multipath

boolean

Не изменять next hop перед анонсированием нескольких путей.

Варианты:

  • false
  • true

set

boolean

Не изменять next hop.

Варианты:

  • false
  • true

optimal_route_reflection_group_name

string

Настроить группу оптимального отражения маршрутов.

orf_route_policy

string

Указать ORF и критерии входящей фильтрации.’

origin_as

dictionary

Параметры origin-AS BGP.

validation

dictionary

Параметры проверки origin-AS BGP.

disable

boolean

Отключить проверку origin-AS с помощью RPKI.

Варианты:

  • false
  • true

remove_private_AS

dictionary

Удалить номер частной AS из исходящих обновлений.

entire_aspath

boolean

Удалять только в том случае, если все AS в пути являются частными.

Варианты:

  • false
  • true

inbound

boolean

Удалить номер частной AS из входящих обновлений.

Варианты:

  • false
  • true

inheritance_disable

boolean

Запретить наследование remove-private-AS от родительского элемента.

Варианты:

  • false
  • true

set

boolean

Установить remove private As.

Варианты:

  • false
  • true

route_policy

dictionary

Применить политику маршрутизации к соседу.

inbound

string

Применить политику маршрутизации к входящим маршрутам.

outbound

string

Применить политику маршрутизации к исходящим маршрутам.

route_reflector_client

dictionary

Настроить соседа как клиента Route Reflector.

inheritance_disable

boolean

Запретить наследование route-reflector-client от родительского элемента.

Варианты:

  • false
  • true

set

boolean

Установить route-reflector-client.

Варианты:

  • false
  • true

safi

string

Модификатор семейства адресов

Варианты:

  • "flowspec"
  • "mdt"
  • "multicast"
  • "mvpn"
  • "rt-filter"
  • "tunnel"
  • "unicast"
  • "labeled-unicast"
  • "sr-policy"
  • "link-state"
  • "evpn"
  • "mspw"
  • "vpls-vpws"

send_community_ebgp

dictionary

Отправлять атрибут community этому внешнему соседу.

inheritance_disable

boolean

Запретить наследование send_community_ebgp от родительского элемента.

Варианты:

  • false
  • true

set

boolean

Установить send_community_ebgp.

Варианты:

  • false
  • true

send_community_gshut_ebgp

dictionary

Разрешить отправку community g-shut этому внешнему соседу.

inheritance_disable

boolean

Запретить наследование send_community_gshut_ebgp от родительского элемента.

Варианты:

  • false
  • true

set

boolean

Установить send_community_gshut_ebgp.

Варианты:

  • false
  • true

send_extended_community_ebgp

dictionary

Отправлять атрибут extended community этому внешнему соседу.

inheritance_disable

boolean

Запретить наследование send_extended_community_ebgp от родительского элемента.

Варианты:

  • false
  • true

set

boolean

Установить send_extended_community_ebgp.

Варианты:

  • false
  • true

send_multicast_attributes

dictionary

Отправлять атрибуты многоадресной рассылки этому соседу.

disable

boolean

Отключить отправку атрибутов многоадресной рассылки.

Варианты:

  • false
  • true

set

boolean

Установить send_multicast_attributes.

Варианты:

  • false
  • true

signalling

dictionary

Протоколы сигнализации, которые нужно отключить: BGP или LDP

bgp_disable

boolean

Выбрать BGP для отключения

Варианты:

  • false
  • true

ldp_disable

boolean

Выбрать LDP для отключения

Варианты:

  • false
  • true

soft_reconfiguration

dictionary

Мягкая перенастройка для каждого соседа.

inbound

dictionary

Мягкая перенастройка входящих маршрутов

always

boolean

Разрешить мягкую перенастройку входящих маршрутов для этого соседа. Всегда использовать мягкую перенастройку, даже если поддерживается обновление маршрутов.

Варианты:

  • false
  • true

inheritance_disable

boolean

Запретить наследование soft_reconfiguration от родительского элемента.

Варианты:

  • false
  • true

set

boolean

Установить входящий режим

Варианты:

  • false
  • true

update

dictionary

Обновление

out_originator_loopcheck_disable

boolean

Отключить проверку цикла originator

Варианты:

  • false
  • true

out_originator_loopcheck_set

boolean

Включить проверку цикла originator

Варианты:

  • false
  • true

use

string

Наследовать конфигурацию этого семейства адресов из af-group.

weight

integer

Задать вес по умолчанию для маршрутов от этого соседа.

advertisement_interval

integer

Минимальный интервал между отправками обновлений маршрутизации BGP. Пример: <0-600>.

bfd

dictionary

Настроить параметры BFD.

fast_detect

dictionary

Включить быстрое обнаружение

disable

boolean

Запретить наследование настроек bfd от родительского элемента.

Варианты:

  • false
  • true

set

boolean

Установить fast-detect

Варианты:

  • false
  • true

strict_mode

boolean

Удерживать сеанс соседа до установления сеанса BFD

Варианты:

  • false
  • true

minimum_interval

integer

Задает минимальный интервал сеанса BFD для соседа.

multiplier

integer

Задает значение множителя сеанса BFD для соседа.

bmp_activate

dictionary

Включить ведение журнала BMP для этого соседа.

server

integer

Включить подключение BMP к указанному серверу. Пример: <1-8>.

capability

dictionary

Объявить возможность соседу.

additional_paths

dictionary

Команды BGP additional-paths.

receive

dictionary

Возможность получения дополнительных маршрутов

disable

boolean

Установить возможность получения

Варианты:

  • false
  • true

set

boolean

Установить возможность получения

Варианты:

  • false
  • true

send

dictionary

Возможность отправки дополнительных маршрутов

disable

boolean

Установить возможность отправки

Варианты:

  • false
  • true

set

boolean

Установить возможность отправки

Варианты:

  • false
  • true

suppress

dictionary

Запретить объявление возможности соседу.

all

dictionary

Все возможности

inheritance_disable

boolean

Не наследовать эту конфигурацию от родительской группы.

Варианты:

  • false
  • true

set

boolean

Установить все возможности.

Варианты:

  • false
  • true

four_byte_AS

dictionary

Возможность поддержки 4-байтового AS

set

boolean

Установить 4_byte_as.

Варианты:

  • false
  • true

cluster_id

string

Идентификатор кластера этого маршрутизатора, выполняющего роль отражателя маршрутов.

description

string

Описание конкретного соседа.

dmz_link_bandwidth

dictionary

Передавать пропускную способность канала DMZ.

inheritance_disable

boolean

Не наследовать эту конфигурацию от родительской группы.

Варианты:

  • false
  • true

set

boolean

Установить dmz-link-bandwidth.

Варианты:

  • false
  • true

dscp

string

Установить IP DSCP (кодовую точку DiffServ). Допустимые значения см. в документации поставщика.

ebgp_multihop

dictionary

Разрешить соседство EBGP с узлами в сетях, не подключённых напрямую.

mpls

boolean

Отключить пересылку BGP MPLS.

Варианты:

  • false
  • true

value

integer

Максимальное количество переходов. Пример: <1-255>.

ebgp_recv_extcommunity_dmz

dictionary

Получать от соседа ebgp расширенное сообщество с пропускной способностью канала DMZ.

inheritance_disable

boolean

Запретить наследование ebgp-recv-community-dmz от родительской группы.

Варианты:

  • false
  • true

set

boolean

Установить ebgp-recv-community-dmz.

Варианты:

  • false
  • true

ebgp_send_extcommunity_dmz

dictionary

Отправлять соседу ebgp расширенное сообщество с пропускной способностью канала DMZ.

cumulatie

boolean

Отправлять соседу ebgp совокупную пропускную способность канала DMZ сообщества для всех путей с балансировкой нагрузки.

Варианты:

  • false
  • true

inheritance_disable

boolean

Запретить наследование ebgp-send-community-dmz от родительской группы.

Варианты:

  • false
  • true

set

boolean

Установить ebgp-send-community-dmz.

Варианты:

  • false
  • true

egress_engineering

dictionary

Включить проектирование исходящего трафика для этого соседа.

inheritance_disable

boolean

Запретить наследование egress-engineering от родительской группы.

Варианты:

  • false
  • true

set

boolean

Установить egress-engineering.

Варианты:

  • false
  • true

enforce_first_as

dictionary

Проверять первый номер AS в маршрутах EBGP.

disable

boolean

Отключить проверку первого номера AS.

Варианты:

  • false
  • true

graceful_maintenance

dictionary

Атрибуты корректного обслуживания. Они побуждают соседей отдавать предпочтение альтернативным маршрутам, а не маршрутам от этого маршрутизатора. Это позволяет плавно вводить маршрутизатор в эксплуатацию и выводить его из неё.

activate

dictionary

Маршруты будут объявляться с атрибутами корректного обслуживания, если функция активирована здесь или в конфигурации маршрутизатора BGP.

inheritance_disable

boolean

Запретить наследование параметра activate от родительской группы.

Варианты:

  • false
  • true

set

boolean

Активировать.

Варианты:

  • false
  • true

as_prepends

dictionary

Количество добавлений номера локальной AS в начало пути AS маршрутов. По умолчанию: 0

inheritance_disable

boolean

Запретить наследование параметра добавления AS от родительской группы.

Варианты:

  • false
  • true

value

integer

Диапазон значений для добавления AS. Пример: <0-6>.

local_preference

dictionary

Локальное предпочтение, с которым маршруты объявляются соседям iBGP. По умолчанию: без изменений.

inheritance_disable

boolean

Запретить наследование локального предпочтения от родительской группы.

Варианты:

  • false
  • true

value

integer

Диапазон значений локального предпочтения. Пример: <0-4294967295>.

set

boolean

Установить параметры корректного обслуживания.

Варианты:

  • false
  • true

graceful_restart

dictionary

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

restart_time

integer

Время перезапуска, объявляемое соседям, в секундах <1-4095>.

stalepath_time

integer

Максимальное время ожидания перезапуска узлов-соседей с поддержкой GR в секундах <1-4095>.

idle_watch_time

integer

Максимальное время ожидания удаления динамического соседа в состоянии IDLE.

ignore_connected_check

dictionary

Обходить проверку непосредственно подключённого следующего узла для одношагового пиринга eBGP.

inheritance_disable

boolean

Запретить наследование ignore-connected-check от родительской группы.

Варианты:

  • false
  • true

set

boolean

Установить ignore-connected-check.

Варианты:

  • false
  • true

internal_vpn_client

boolean

Сохранять путь соседа CE iBGP в ATTR_SET через ядро VPN.

Варианты:

  • false
  • true

keychain

dictionary

Настроить аутентификацию на основе связки ключей.

inheritance_disable

boolean

Запретить наследование связки ключей от родительской группы.

Варианты:

  • false
  • true

name

string

Имя связки ключей — не более 32 символов.

local

dictionary

Настроить локальный параметр.

address

dictionary

Адрес IPv4.

inheritance_disable

boolean

Запретить наследование локального адреса от родительской группы.

Варианты:

  • false
  • true

ipv4_address

string

Адрес IPv4 <A.B.C.D>.

local_address_subnet

string

Подсеть локального адреса обновлений маршрутизации.

local_as

dictionary

Указать номер локальной AS.

inheritance_disable

boolean

Запретить наследование локальной AS от родительской группы.

Варианты:

  • false
  • true

no_prepend

dictionary

Не добавлять локальную AS в начало объявлений от этого соседа.

replace_as

dictionary

Добавлять в начало объявлений для этого соседа только локальную AS.

dual_as

boolean

Режим Dual-AS.

Варианты:

  • false
  • true

set

boolean

Добавлять в начало объявлений для этого соседа только локальную AS.

Варианты:

  • false
  • true

set

boolean

Не добавлять локальную AS в начало объявлений от этого соседа.

Варианты:

  • false
  • true

value

integer

Номер AS длиной 2 или 4 байта.

log

dictionary

Ведение журнала сообщений об обновлениях для каждого соседа.

log_message

dictionary

Ведение журнала сообщений об обновлениях и уведомлениях для каждого соседа.

in

dictionary

Входящие сообщения журнала.

disable

boolean

Отключить журналирование входящих сообщений.

Варианты:

  • false
  • true

inheritance_disable

boolean

Не позволяет наследовать журнал сообщений от родительского объекта.

Варианты:

  • false
  • true

value

integer

Диапазон размера буфера журнала сообщений <1-100>.

out

dictionary

Исходящие сообщения журнала

disable

boolean

Отключить регистрацию входящих сообщений.

Варианты:

  • false
  • true

inheritance_disable

boolean

Не позволяет наследовать журнал сообщений от родительского объекта.

Варианты:

  • false
  • true

value

integer

Диапазон размера буфера журнала сообщений <1-100>.

maximum_peers

integer

Максимальное количество динамических соседей <1-4095>.

name

string

Имя группы соседей.

password

dictionary

Задать пароль.

encrypted

string

Указывает, что далее будет указан ЗАШИФРОВАННЫЙ пароль.

inheritance_disable

boolean

Не позволяет наследовать пароль от родительского объекта.

Варианты:

  • false
  • true

peer_set

integer

Назначить этого соседа набору пиров, используемому для инженерии исходящих пиров <1-255>.

precedence

string

Задать приоритет

Варианты:

  • "critical"
  • "flash"
  • "flash-override"
  • "immediate"
  • "internet"
  • "network"
  • "priority"
  • "routine"

receive_buffer_size

integer

Задать размер буфера сокета и буфера приема BGP. Пример: <512-131072>.

remote_as

string

Автономная система соседа.

remote_as_list

string

Конфигурация списка удаленных автономных систем

send_buffer_size

integer

Задать размер буфера сокета и буфера отправки BGP. Пример: <4096-131072>.

session_open_mode

string

Устанавливать сеанс BGP, используя этот режим открытия TCP-соединения.

Варианты:

  • "active-only"
  • "both"
  • "passive-only"

shutdown

dictionary

Административно отключить этого соседа.

inheritance_disable

boolean

Не позволяет наследовать отключение от родительского объекта

Варианты:

  • false
  • true

set

boolean

Отключение.

Варианты:

  • false
  • true

tcp

dictionary

Команды настройки сеанса TCP.

mss

dictionary

Максимальный размер сегмента.

inheritance_disable

boolean

Не позволяет наследовать MSS от родительского объекта

Варианты:

  • false
  • true

value

integer

Начальный максимальный размер сегмента TCP.

timers

dictionary

Таймеры BGP для каждого соседа.

holdtime

integer

Время удержания <3-65535> или 0 для отключения времени удержания.

keepalive_time

integer

Интервал keepalive <0-65535>.

min_holdtime

integer

Минимальное допустимое время удержания от соседа <3-65535>.

ttl_security

dictionary

Включить защиту TTL для EBGP.

inheritance_disable

boolean

Не позволяет наследовать защиту TTL от родительского объекта

Варианты:

  • false
  • true

set

boolean

Включить защиту TTL

Варианты:

  • false
  • true

update

dictionary

Настройка обновлений BGP.

in

dictionary

Обработка входящих сообщений об обновлении.

filtering

dictionary

Фильтрация входящих сообщений об обновлении

attribute_filter

dictionary

Настройка фильтра атрибутов.

group

string

Имя группы.

logging

dictionary

Сообщение syslog о фильтрации обновлений.

disable

boolean

Отключить сообщения syslog о фильтрации обновлений.

Варианты:

  • false
  • true

update_message

dictionary

Отфильтрованные сообщения об обновлении.

buffers

integer

Количество буферов для хранения отфильтрованных сообщений об обновлении.

update_source

string

Источник обновлений маршрутизации. Допустимые значения см. в документации производителя.

use

dictionary

Использовать шаблон группы соседей и группы сеансов.

neighbor_group

string

Наследовать конфигурацию от группы соседей.

session_group

string

Наследовать конфигурацию, независимую от семейства адресов, из группы сеансов

running_config

string

Этот параметр используется только при состоянии parsed.

Значением этого параметра должен быть вывод, полученный с устройства Iosxr при выполнении команды 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/RP0/CPU0:10#show running-config router bgp
# Thu Mar 23 10:00:12.668 UTC
# % No such configuration item(s)
#
# RP/0/RP0/CPU0:10#

- name: Merge the provided configuration with the existing running configuration
  cisco.iosxr.iosxr_bgp_templates:
    config:
      as_number: 65536
      neighbor:
        - address_family:
            - advertise:
                local_labeled_route:
                  set: true
              afi: ipv4
              safi: unicast
          advertisement_interval: 10
          bfd:
            fast_detect:
              strict_mode: true
          internal_vpn_client: true
          name: neighbor-group1
          precedence: critical
        - cluster_id: '1'
          description: neighbor-group2
          dmz_link_bandwidth:
            set: true
          ebgp_multihop:
            value: 255
          egress_engineering:
            set: true
          graceful_maintenance:
            as_prepends:
              value: 0
            set: true
          ignore_connected_check:
            set: true
          internal_vpn_client: true
          local:
            address:
              inheritance_disable: true
          local_as:
            value: 6
          name: neighbor-group2
          precedence: flash
          receive_buffer_size: 512
          send_buffer_size: 4096
          session_open_mode: both
          tcp:
            mss:
              inheritance_disable: true
          ttl_security:
            set: true
          update_source: Loopback919
    state: merged

# Task Output
# -----------
# before: {}
# commands:
# - router bgp 65536
# - neighbor-group neighbor-group1
# - advertisement-interval 10
# - bfd fast-detect strict-mode
# - internal-vpn-client
# - precedence critical
# - address-family ipv4 unicast
# - advertise local-labeled-route
# - neighbor-group neighbor-group2
# - dmz-link-bandwidth
# - description neighbor-group2
# - cluster-id 1
# - ebgp-multihop 255
# - egress-engineering
# - internal-vpn-client
# - ignore-connected-check
# - local-as 6
# - local address inheritance-disable
# - precedence flash
# - receive-buffer-size 512
# - send-buffer-size 4096
# - session-open-mode both
# - tcp mss inheritance-disable
# - update-source Loopback919
# - ttl-security
# - graceful-maintenance
# - graceful-maintenance as-prepends 0
# after:
#   as_number: '65536'
#   neighbor:
#     - address_family:
#         - advertise:
#             local_labeled_route:
#               set: true
#           afi: ipv4
#           safi: unicast
#       advertisement_interval: 10
#       bfd:
#         fast_detect:
#           strict_mode: true
#       internal_vpn_client: true
#       name: neighbor-group1
#       precedence: critical
#     - cluster_id: '1'
#       description: neighbor-group2
#       dmz_link_bandwidth:
#         set: true
#       ebgp_multihop:
#         value: 255
#       egress_engineering:
#         set: true
#       graceful_maintenance:
#         as_prepends:
#           value: 0
#         set: true
#       ignore_connected_check:
#         set: true
#       internal_vpn_client: true
#       local:
#         address:
#           inheritance_disable: true
#       local_as:
#         value: 6
#       name: neighbor-group2
#       precedence: flash
#       receive_buffer_size: 512
#       send_buffer_size: 4096
#       session_open_mode: both
#       tcp:
#         mss:
#           inheritance_disable: true
#       ttl_security:
#         set: true
#       update_source: Loopback919

# After state:
# ------------
# RP/0/RP0/CPU0:10#show running-config router bgp
# Thu Mar 23 10:14:33.116 UTC
# router bgp 65536
#  neighbor-group neighbor-group1
#   bfd fast-detect strict-mode
#   precedence critical
#   advertisement-interval 10
#   internal-vpn-client
#   address-family ipv4 unicast
#    advertise local-labeled-route
#   !
#  !
#  neighbor-group neighbor-group2
#   ebgp-multihop 255
#   egress-engineering
#   precedence flash
#   graceful-maintenance
#    as-prepends 0
#   !
#   tcp mss inheritance-disable
#   local-as 6
#   cluster-id 1
#   dmz-link-bandwidth
#   description neighbor-group2
#   ttl-security
#   local address inheritance-disable
#   update-source Loopback919
#   ignore-connected-check
#   session-open-mode both
#   send-buffer-size 4096
#   receive-buffer-size 512
#   internal-vpn-client
#  !
# !


# Using replaced
# Before state:
# ------------
# RP/0/RP0/CPU0:10#show running-config router bgp
# Thu Mar 23 10:14:33.116 UTC
# router bgp 65536
#  neighbor-group neighbor-group1
#   bfd fast-detect strict-mode
#   precedence critical
#   advertisement-interval 10
#   internal-vpn-client
#   address-family ipv4 unicast
#    advertise local-labeled-route
#   !
#  !
#  neighbor-group neighbor-group2
#   ebgp-multihop 255
#   egress-engineering
#   precedence flash
#   graceful-maintenance
#    as-prepends 0
#   !
#   tcp mss inheritance-disable
#   local-as 6
#   cluster-id 1
#   dmz-link-bandwidth
#   description neighbor-group2
#   ttl-security
#   local address inheritance-disable
#   update-source Loopback919
#   ignore-connected-check
#   session-open-mode both
#   send-buffer-size 4096
#   receive-buffer-size 512
#   internal-vpn-client
#  !
# !

- name: Replaced given bgp_templates configuration
  cisco.iosxr.iosxr_bgp_templates:
    config:
      as_number: 65536
      neighbor:
        - address_family:
            - advertise:
                local_labeled_route:
                  set: true
              afi: ipv4
              safi: unicast
          advertisement_interval: 12
          name: neighbor-group1
          precedence: flash
        - cluster_id: '2'
          description: replace neighbor-group2
          ebgp_multihop:
            value: 254
          graceful_maintenance:
            as_prepends:
              value: 2
            set: true
          update_source: Loopback917
          name: neighbor-group2
    state: replaced

# Task Output
# -----------
# before:
#   as_number: '65536'
#   neighbor:
#     - address_family:
#         - advertise:
#             local_labeled_route:
#               set: true
#           afi: ipv4
#           safi: unicast
#       advertisement_interval: 10
#       bfd:
#         fast_detect:
#           strict_mode: true
#       internal_vpn_client: true
#       name: neighbor-group1
#       precedence: critical
#     - cluster_id: '1'
#       description: neighbor-group2
#       dmz_link_bandwidth:
#         set: true
#       ebgp_multihop:
#         value: 255
#       egress_engineering:
#         set: true
#       graceful_maintenance:
#         as_prepends:
#           value: 0
#         set: true
#       ignore_connected_check:
#         set: true
#       internal_vpn_client: true
#       local:
#         address:
#           inheritance_disable: true
#       local_as:
#         value: 6
#       name: neighbor-group2
#       precedence: flash
#       receive_buffer_size: 512
#       send_buffer_size: 4096
#       session_open_mode: both
#       tcp:
#         mss:
#           inheritance_disable: true
#       ttl_security:
#         set: true
#       update_source: Loopback919
# commands:
# - router bgp 65536
# - neighbor-group neighbor-group1
# - no bfd fast-detect strict-mode
# - no internal-vpn-client
# - advertisement-interval 12
# - precedence flash
# - neighbor-group neighbor-group2
# - no dmz-link-bandwidth
# - no egress-engineering
# - no internal-vpn-client
# - no ignore-connected-check
# - no local-as 6
# - no local address inheritance-disable
# - no precedence flash
# - no receive-buffer-size 512
# - no send-buffer-size 4096
# - no session-open-mode both
# - no tcp mss inheritance-disable
# - no ttl-security
# - description replace neighbor-group2
# - cluster-id 2
# - ebgp-multihop 254
# - update-source Loopback917
# - graceful-maintenance as-prepends 2
# after:
#   as_number: '65536'
#   neighbor:
#     - address_family:
#         - advertise:
#             local_labeled_route:
#               set: true
#           afi: ipv4
#           safi: unicast
#       advertisement_interval: 12
#       name: neighbor-group1
#       precedence: flash
#     - cluster_id: '2'
#       description: replace neighbor-group2
#       ebgp_multihop:
#         value: 254
#       graceful_maintenance:
#         as_prepends:
#           value: 2
#         set: true
#       name: neighbor-group2
#       update_source: Loopback917

# After state:
# ------------
# RP/0/RP0/CPU0:10#show running-config router bgp
# Thu Mar 23 10:23:34.104 UTC
# router bgp 65536
#  neighbor-group neighbor-group1
#   precedence flash
#   advertisement-interval 12
#   address-family ipv4 unicast
#    advertise local-labeled-route
#   !
#  !
#  neighbor-group neighbor-group2
#   ebgp-multihop 254
#   graceful-maintenance
#    as-prepends 2
#   !
#   cluster-id 2
#   description replace neighbor-group2
#   update-source Loopback917
#  !
# !


# Using deleted
# Before state:
# -------------
# RP/0/RP0/CPU0:10#show running-config router bgp
# Thu Mar 23 10:23:34.104 UTC
# router bgp 65536
#  neighbor-group neighbor-group1
#   precedence flash
#   advertisement-interval 12
#   address-family ipv4 unicast
#    advertise local-labeled-route
#   !
#  !
#  neighbor-group neighbor-group2
#   ebgp-multihop 254
#   graceful-maintenance
#    as-prepends 2
#   !
#   cluster-id 2
#   description replace neighbor-group2
#   update-source Loopback917
#  !
# !

- name: Delete given bgp_nbr_address_family configuration
  cisco.iosxr.iosxr_bgp_templates: &deleted
    config:
    state: deleted

# Task Output
# -----------
# before:
#   as_number: '65536'
#   neighbor:
#     - address_family:
#         - advertise:
#             local_labeled_route:
#               set: true
#           afi: ipv4
#           safi: unicast
#       advertisement_interval: 12
#       name: neighbor-group1
#       precedence: flash
#     - cluster_id: '2'
#       description: replace neighbor-group2
#       ebgp_multihop:
#         value: 254
#       graceful_maintenance:
#         as_prepends:
#           value: 2
#         set: true
#       name: neighbor-group2
#       update_source: Loopback917
# commands:
# - router bgp 65536
# - no neighbor-group neighbor-group1
# - no neighbor-group neighbor-group2
# after: {}

# After state:
# -------------
# RP/0/RP0/CPU0:10#show running-config router bgp
# Thu Mar 23 10:00:12.668 UTC
# % No such configuration item(s)
#
# RP/0/RP0/CPU0:10#

# Using gathered
# Before state:
# -------------
# RP/0/RP0/CPU0:10#show running-config router bgp
# Thu Mar 23 10:30:38.785 UTC
# router bgp 65536
#  neighbor-group neighbor-group1
#   bfd fast-detect strict-mode
#   precedence critical
#   advertisement-interval 10
#   internal-vpn-client
#   address-family ipv4 unicast
#    advertise local-labeled-route
#   !
#  !
#  neighbor-group neighbor-group2
#   ebgp-multihop 255
#   egress-engineering
#   precedence flash
#   graceful-maintenance
#    as-prepends 0
#   !
#   tcp mss inheritance-disable
#   local-as 6
#   cluster-id 1
#   dmz-link-bandwidth
#   description neighbor-group2
#   ttl-security
#   local address inheritance-disable
#   update-source Loopback919
#   ignore-connected-check
#   session-open-mode both
#   send-buffer-size 4096
#   receive-buffer-size 512
#   internal-vpn-client
#  !
# !

- name: Gather given bgp_templates configuration
  cisco.iosxr.iosxr_bgp_templates: &id001
    config:
    state: gathered

# Task output
# -----------
# gathered:
#   as_number: '65536'
#   neighbor:
#     - address_family:
#         - advertise:
#             local_labeled_route:
#               set: true
#           afi: ipv4
#           safi: unicast
#       advertisement_interval: 10
#       bfd:
#         fast_detect:
#           strict_mode: true
#       internal_vpn_client: true
#       name: neighbor-group1
#       precedence: critical
#     - cluster_id: '1'
#       description: neighbor-group2
#       dmz_link_bandwidth:
#         set: true
#       ebgp_multihop:
#         value: 255
#       egress_engineering:
#         set: true
#       graceful_maintenance:
#         as_prepends:
#           value: 0
#         set: true
#       ignore_connected_check:
#         set: true
#       internal_vpn_client: true
#       local:
#         address:
#           inheritance_disable: true
#       local_as:
#         value: 6
#       name: neighbor-group2
#       precedence: flash
#       receive_buffer_size: 512
#       send_buffer_size: 4096
#       session_open_mode: both
#       tcp:
#         mss:
#           inheritance_disable: true
#       ttl_security:
#         set: true
#       update_source: Loopback919


# Using overridden

# Before state:
# -------------
# RP/0/RP0/CPU0:10#show running-config router bgp
# Thu Mar 23 10:30:38.785 UTC
# router bgp 65536
#  neighbor-group neighbor-group1
#   bfd fast-detect strict-mode
#   precedence critical
#   advertisement-interval 10
#   internal-vpn-client
#   address-family ipv4 unicast
#    advertise local-labeled-route
#   !
#  !
#  neighbor-group neighbor-group2
#   ebgp-multihop 255
#   egress-engineering
#   precedence flash
#   graceful-maintenance
#    as-prepends 0
#   !
#   tcp mss inheritance-disable
#   local-as 6
#   cluster-id 1
#   dmz-link-bandwidth
#   description neighbor-group2
#   ttl-security
#   local address inheritance-disable
#   update-source Loopback919
#   ignore-connected-check
#   session-open-mode both
#   send-buffer-size 4096
#   receive-buffer-size 512
#   internal-vpn-client
#  !
# !
- name: override given bgp_templates configuration
  cisco.iosxr.iosxr_bgp_templates:
    config:
      as_number: 65536
      neighbor:
        - address_family:
            - advertise:
                local_labeled_route:
                  disable: true
              afi: ipv4
              safi: unicast
          advertisement_interval: 12
          bfd:
            fast_detect:
              strict_mode: true
          name: neighbor-group1
          precedence: flash
    state: overridden

# Task Output
# -----------
# before:
#   as_number: '65536'
#   neighbor:
#     - address_family:
#         - advertise:
#             local_labeled_route:
#               set: true
#           afi: ipv4
#           safi: unicast
#       advertisement_interval: 10
#       bfd:
#         fast_detect:
#           strict_mode: true
#       internal_vpn_client: true
#       name: neighbor-group1
#       precedence: critical
#     - cluster_id: '1'
#       description: neighbor-group2
#       dmz_link_bandwidth:
#         set: true
#       ebgp_multihop:
#         value: 255
#       egress_engineering:
#         set: true
#       graceful_maintenance:
#         as_prepends:
#           value: 0
#         set: true
#       ignore_connected_check:
#         set: true
#       internal_vpn_client: true
#       local:
#         address:
#           inheritance_disable: true
#       local_as:
#         value: 6
#       name: neighbor-group2
#       precedence: flash
#       receive_buffer_size: 512
#       send_buffer_size: 4096
#       session_open_mode: both
#       tcp:
#         mss:
#           inheritance_disable: true
#       ttl_security:
#         set: true
#       update_source: Loopback919
# commands:
# - router bgp 65536
# - no neighbor-group neighbor-group2
# - neighbor-group neighbor-group1
# - no internal-vpn-client
# - advertisement-interval 12
# - precedence flash
# - address-family ipv4 unicast
# - no advertise local-labeled-route
# - advertise local-labeled-route disable
# after:
#   as_number: '65536'
#   neighbor:
#     - address_family:
#         - advertise:
#             local_labeled_route:
#               disable: true
#           afi: ipv4
#           safi: unicast
#       advertisement_interval: 12
#       bfd:
#         fast_detect:
#           strict_mode: true
#       name: neighbor-group1
#       precedence: flash


# Using rendered
- name: >-
    Render platform specific configuration lines with state rendered (without
    connecting to the device)
  cisco.iosxr.iosxr_bgp_templates:
    config:
      as_number: 65536
      neighbor:
        - address_family:
            - advertise:
                local_labeled_route:
                  set: true
              afi: ipv4
              safi: unicast
          advertisement_interval: 10
          bfd:
            fast_detect:
              strict_mode: true
          internal_vpn_client: true
          name: neighbor-group1
          precedence: critical
        - cluster_id: '1'
          description: neighbor-group2
          dmz_link_bandwidth:
            set: true
          ebgp_multihop:
            value: 255
          egress_engineering:
            set: true
          graceful_maintenance:
            as_prepends:
              value: 0
            set: true
          ignore_connected_check:
            set: true
          internal_vpn_client: true
          local:
            address:
              inheritance_disable: true
          local_as:
            value: 6
          name: neighbor-group2
          precedence: flash
          receive_buffer_size: 512
          send_buffer_size: 4096
          session_open_mode: both
          tcp:
            mss:
              inheritance_disable: true
          ttl_security:
            set: true
          update_source: Loopback919
    state: rendered

# Task Output
# -----------
# rendered:
# - router bgp 65536
# - neighbor-group neighbor-group1
# - advertisement-interval 10
# - bfd fast-detect strict-mode
# - internal-vpn-client
# - precedence critical
# - address-family ipv4 unicast
# - advertise local-labeled-route
# - neighbor-group neighbor-group2
# - dmz-link-bandwidth
# - description neighbor-group2
# - cluster-id 1
# - ebgp-multihop 255
# - egress-engineering
# - internal-vpn-client
# - ignore-connected-check
# - local-as 6
# - local address inheritance-disable
# - precedence flash
# - receive-buffer-size 512
# - send-buffer-size 4096
# - session-open-mode both
# - tcp mss inheritance-disable
# - update-source Loopback919
# - ttl-security
# - graceful-maintenance
# - graceful-maintenance as-prepends 0


# Using parsed
- name: Parse externally provided BGP configuration
  register: result
  cisco.iosxr.iosxr_bgp_templates:
    running_config: "{{ lookup('file', 'parsed.cfg') }}"
    state: parsed

# content of pared.cfg
# router bgp 65536
#  neighbor-group neighbor-group1
#   bfd fast-detect strict-mode
#   precedence critical
#   advertisement-interval 10
#   internal-vpn-client
#   address-family ipv4 unicast
#    advertise local-labeled-route
#   !
#  !
#  neighbor-group neighbor-group2
#   ebgp-multihop 255
#   egress-engineering
#   precedence flash
#   graceful-maintenance
#    as-prepends 0
#   !
#   tcp mss inheritance-disable
#   local-as 6
#   cluster-id 1
#   dmz-link-bandwidth
#   description neighbor-group2
#   ttl-security
#   local address inheritance-disable
#   update-source Loopback919
#   idle-watch-time 30
#   ignore-connected-check
#   session-open-mode both
#   send-buffer-size 4096
#   receive-buffer-size 512
#   internal-vpn-client
#  !
# !
# Task output
# -----------
# parsed:
#   as_number: '65536'
#   neighbor:
#     - address_family:
#         - advertise:
#             local_labeled_route:
#               set: true
#           afi: ipv4
#           safi: unicast
#       advertisement_interval: 10
#       bfd:
#         fast_detect:
#           strict_mode: true
#       internal_vpn_client: true
#       name: neighbor-group1
#       precedence: critical
#     - cluster_id: '1'
#       description: neighbor-group2
#       dmz_link_bandwidth:
#         set: true
#       ebgp_multihop:
#         value: 255
#       egress_engineering:
#         set: true
#       graceful_maintenance:
#         as_prepends:
#           value: 0
#         set: true
#       ignore_connected_check:
#         set: true
#       internal_vpn_client: true
#       local:
#         address:
#           inheritance_disable: true
#       local_as:
#         value: 6
#       name: neighbor-group2
#       precedence: flash
#       receive_buffer_size: 512
#       send_buffer_size: 4096
#       session_open_mode: both
#       tcp:
#         mss:
#           inheritance_disable: true
#       ttl_security:
#         set: true
#       update_source: Loopback919

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

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

Ключ

Описание

after

dictionary

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

Возвращается: если конфигурация изменена

Пример: "This output will always be in the same format as the module argspec.\n"

before

dictionary

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

Возвращается: если state равно merged, replaced, overridden, deleted или purged

Пример: "This output will always be in the same format as the module argspec.\n"

commands

list / elements=string

Набор команд, отправленных на удаленное устройство.

Возвращается: если state равно merged, replaced, overridden, deleted или purged

Пример: ["router bgp 65536", "neighbor-group neighbor-group1", "advertisement-interval 10", "bfd fast-detect strict-mode", "internal-vpn-client"]

gathered

list / elements=string

Факты о сетевом ресурсе, собранные с удаленного устройства в виде структурированных данных.

Возвращается: если state равно gathered

Пример: ["This output will always be in the same format as the module argspec.\n"]

parsed

list / elements=string

Исходная конфигурация устройства, указанная в параметре running_config и разобранная в структурированные данные согласно спецификации аргументов модуля.

Возвращается: если state равно parsed

Пример: ["This output will always be in the same format as the module argspec.\n"]

rendered

list / elements=string

Переданная конфигурация задачи преобразована в собственный формат устройства (автономный режим).

Возвращается: если state равно rendered

Пример: ["router bgp 65536", "neighbor-group neighbor-group1", "advertisement-interval 10", "bfd fast-detect strict-mode", "internal-vpn-client"]

Авторы

  • 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_templates_module.html

Spec-Zone.ru

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