Модуль cisco.nxos.nxos_bgp_templates — модуль ресурсов шаблонов BGP.
Примечание
Этот модуль является частью коллекции cisco.nxos (версия 11.2.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install cisco.nxos.
Чтобы использовать её в плейбуке, укажите: cisco.nxos.nxos_bgp_templates.
Новое в cisco.nxos 4.2.0
Обзор
- Этот модуль управляет шаблонами BGP на устройствах под управлением Cisco NX-OS.
Параметры
Параметр | Комментарии |
|---|---|
config dictionary | Список шаблонов BGP. |
|
as_number string |
Номер автономной системы маршрутизатора. |
|
neighbor list / elements=dictionary |
Настройка шаблонов узлов BGP. |
|
address_family list / elements=dictionary |
Настройка семейства адресов для узла. |
|
advertise_map dictionary |
Укажите route-map для условной рекламы маршрутов. |
|
exist_map string |
Условная route-map для рекламы маршрутов только при наличии префикса, указанного в условии. |
|
non_exist_map string |
Условная route-map для рекламы маршрутов только при отсутствии префикса, указанного в условии. |
|
route_map string / обязательный |
Имя route-map. |
|
advertisement_interval integer |
Минимальный интервал между отправкой обновлений маршрутизации BGP. |
|
afi string / обязательный |
Индикатор семейства адресов. Варианты:
|
|
allowas_in dictionary |
Принимать AS-path, содержащий номер моей AS. |
|
max_occurences integer |
Количество вхождений номера AS; значение по умолчанию — 3. |
|
set boolean |
Активировать свойство allowas-in. Варианты:
|
|
as_override boolean |
Заменять совпадающий номер AS при отправке обновления. Варианты:
|
|
capability dictionary |
Объявлять возможность узлу. |
|
additional_paths dictionary |
Возможность передачи дополнительных путей. |
|
receive string |
Возможность приёма дополнительных путей. Варианты:
|
|
send string |
Возможность отправки дополнительных путей. Варианты:
|
|
default_originate dictionary |
Анонсировать маршрут по умолчанию этому узлу. |
|
route_map string |
Route-map для задания критериев анонсирования маршрута по умолчанию. |
|
set boolean |
Задать атрибут default-originate. Варианты:
|
|
disable_peer_as_check boolean |
Отключить проверку номера AS узла при анонсировании маршрутов. Варианты:
|
|
filter_list dictionary |
Имя списка фильтров. |
|
inbound string |
Применить политику к входящим маршрутам. |
|
outbound string |
Применить политику к исходящим маршрутам. |
|
inherit dictionary |
Наследовать шаблон политики узла. |
|
peer_policy string |
Шаблон политики узла для наследования. |
|
maximum_prefix dictionary |
Максимальное количество префиксов от этого узла. |
|
generate_warning_threshold integer |
Пороговое значение в процентах, при достижении которого выводится предупреждение. |
|
max_prefix_limit integer |
Максимальный предел количества префиксов. |
|
restart_interval integer |
Перезапустить соединение BGP после превышения предела. |
|
warning_only boolean |
Только выводить предупреждение при превышении предела. Варианты:
|
|
next_hop_self dictionary |
Указать наш адрес в качестве следующего перехода (для непереотражённых маршрутов). |
|
all_routes boolean |
Указать наш адрес в качестве следующего перехода для всех маршрутов. Варианты:
|
|
set boolean |
Задать атрибут next-hop-self. Варианты:
|
|
next_hop_third_party boolean |
Вычислять сторонний адрес следующего перехода, если это возможно. Варианты:
|
|
prefix_list dictionary |
Применить список префиксов. |
|
inbound string |
Применить политику к входящим маршрутам. |
|
outbound string |
Применить политику к исходящим маршрутам. |
|
route_map dictionary |
Применить route-map к узлу. |
|
inbound string |
Имя политики для применения к входящим маршрутам. |
|
outbound string |
Имя политики для применения к исходящим маршрутам. |
|
route_reflector_client boolean |
Настроить узел как клиент route reflector. Варианты:
|
|
safi string |
Индикатор подсемейства адресов. Варианты:
|
|
send_community string |
Отправлять атрибут Community этому узлу. Варианты:
|
|
soft_reconfiguration_inbound dictionary |
Мягкая реконфигурация. |
|
always boolean |
Всегда выполнять входящую мягкую реконфигурацию. Варианты:
|
|
set boolean |
Задать атрибут soft-reconfiguration inbound. Варианты:
|
|
soo string |
Укажите расширенное сообщество Site-of-Origin. |
|
suppress_inactive boolean |
Анонсировать узлу только активные маршруты. Варианты:
|
|
unsuppress_map string |
Route-map для выборочного восстановления подавленных маршрутов. |
|
weight integer |
Задать вес по умолчанию для маршрутов от этого узла. |
|
bfd dictionary |
Двунаправленное быстрое обнаружение (BFD) для узла. |
|
multihop dictionary |
Многопереходный сеанс. |
|
interval dictionary |
Настройка параметров интервала сеанса BFD. |
|
min_rx_interval integer / обязательный |
Минимальный интервал приёма (RX). |
|
multiplier integer / обязательный |
Множитель обнаружения. |
|
tx_interval integer / обязательный |
Интервал передачи (TX) в миллисекундах. |
|
set boolean |
Включить многопереходный режим BFD. Варианты:
|
|
set boolean |
Включить BFD для этого узла. Варианты:
|
|
singlehop boolean |
Однопереходный сеанс. Варианты:
|
|
bmp_activate_server integer |
Укажите идентификатор сервера для активации мониторинга BMP узла. |
|
capability dictionary |
Возможность. |
|
suppress_4_byte_as boolean |
Подавлять возможность поддержки 4-байтовых AS. Варианты:
|
|
description string |
Описание данного соседа. |
|
disable_connected_check boolean |
Отключить проверку прямого подключения соседа. Варианты:
|
|
dont_capability_negotiate boolean |
Не согласовывать возможности с этим соседом. Варианты:
|
|
dscp string |
Задать значение DSCP для транспортного протокола TCP. |
|
dynamic_capability boolean |
Динамическая возможность Варианты:
|
|
ebgp_multihop integer |
Указать TTL для удалённого соседа при многошаговом подключении. |
|
graceful_shutdown dictionary |
Корректное завершение работы для этого соседа. |
|
activate dictionary |
Отправлять сообщество graceful-shutdown. |
|
route_map string |
Применить route-map для изменения атрибутов исходящих маршрутов. |
|
set boolean |
Задать параметр activate. Варианты:
|
|
inherit dictionary |
Наследовать шаблон. |
|
peer_session string |
Шаблон peer-session для наследования. |
|
local_as string |
Указать номер локальной AS для соседа eBGP. |
|
log_neighbor_changes dictionary |
Запись сообщений о событиях подключения и отключения соседа. |
|
disable boolean |
Отключить запись событий подключения и отключения соседа. Варианты:
|
|
set boolean |
Задать параметр log-neighbor-changes. Варианты:
|
|
low_memory dictionary |
Поведение при нехватке памяти. |
|
exempt boolean |
Не отключать этого соседа при нехватке памяти. Варианты:
|
|
name string |
Имя шаблона соседа BGP. |
|
password dictionary |
Настроить пароль для соседа. |
|
encryption integer |
Значение 0 указывает, что пароль соседа НЕ ЗАШИФРОВАН. Значение 3 указывает, что далее следует пароль соседа, ЗАШИФРОВАННЫЙ 3DES. Значение 7 указывает, что далее следует пароль соседа, ЗАШИФРОВАННЫЙ методом Cisco типа 7. |
|
key string |
Пароль аутентификации. |
|
path_attribute list / elements=dictionary |
Необязательная фильтрация атрибутов пути BGP. |
|
action string |
Действие. Варианты:
|
|
range dictionary |
Диапазон атрибутов пути. |
|
end integer |
Конечное значение диапазона атрибутов пути. |
|
start integer |
Начальное значение диапазона атрибутов пути. |
|
type integer |
Тип атрибута пути |
|
remote_as string |
Указать номер автономной системы соседа. |
|
remove_private_as dictionary |
Удалить номер частной AS из исходящих обновлений. |
|
all boolean |
Все. Варианты:
|
|
replace_as boolean |
Заменить. Варианты:
|
|
set boolean |
Удалить частную AS. Варианты:
|
|
shutdown boolean |
Административно отключить этого соседа. Варианты:
|
|
timers dictionary |
Настроить таймеры keepalive и hold. |
|
holdtime integer |
Время удержания (секунды). |
|
keepalive integer |
Интервал keepalive (секунды). |
|
transport dictionary |
Транспортное соединение BGP. |
|
connection_mode dictionary |
Указать тип соединения. |
|
passive boolean |
Разрешить только пассивное установление соединения. Варианты:
|
|
ttl_security dictionary |
Включить механизм безопасности TTL. |
|
hops integer |
Указать количество переходов до удалённого соседа. |
|
update_source string |
Указать источник сеанса BGP и обновлений. |
running_config string | Этот параметр используется только при состоянии parsed. Значением этого параметра должен быть вывод, полученный с устройства NX-OS при выполнении команды show running-config bgp | section ‘template’. Состояние parsed считывает конфигурацию из параметра |
state string | Состояние, в котором должна остаться конфигурация. Подробнее см. примеры. Варианты:
|
Примечания
Примечание
- Проверено на NX-OS 9.3.6.
- Не поддерживается на Cisco MDS
- Этот модуль работает с подключениями
network_cliиhttpapi.
Примеры
# Using merged
# Before state:
# --------------
#
# nxos9k# show running-config | section "^router bgp"
# nxos9k#
- name: Merge the provided configuration with the existing running configuration
cisco.nxos.nxos_bgp_templates:
config:
as_number: 65536
neighbor:
- name: neighbor_tmplt_1
address_family:
- afi: ipv4
safi: unicast
advertise_map:
route_map: rmap1
non_exist_map: nemap1
advertisement_interval: 60
disable_peer_as_check: true
bmp_activate_server: 2
capability:
suppress_4_byte_as: true
description: Test_BGP_PEER_TEMPLATE_1
local_as: 65536
remote_as: 65001
- name: neighbor_tmplt_2
description: Test_BGP_PEER_TEMPLATE_2
address_family:
- afi: ipv4
safi: multicast
advertise_map:
route_map: rmap1
exist_map: emap1
as_override: true
filter_list:
inbound: flist1
outbound: flist2
inherit:
peer_session: psession1
timers:
holdtime: 100
keepalive: 45
# Task Output:
# ------------
# before: {}
#
# commands:
# - router bgp 65536
# - template peer neighbor_tmplt_1
# - bmp-activate-server 2
# - capability suppress 4-byte-as
# - description Test_BGP_PEER_TEMPLATE_1
# - local-as 65536
# - remote-as 65001
# - address-family ipv4 unicast
# - advertise-map rmap1 non-exist-map nemap1
# - advertisement-interval 60
# - disable-peer-as-check
# - template peer neighbor_tmplt_2
# - description Test_BGP_PEER_TEMPLATE_2
# - inherit peer-session psession1
# - timers 45 100
# - address-family ipv4 multicast
# - advertise-map rmap1 exist-map emap1
# - as-override
# - filter-list flist1 in
# - filter-list flist2 out
#
# after:
# as_number: "65536"
# neighbor:
# - name: neighbor_tmplt_1
# address_family:
# - afi: ipv4
# safi: unicast
# advertise_map:
# non_exist_map: nemap1
# route_map: rmap1
# advertisement_interval: 60
# disable_peer_as_check: true
# bmp_activate_server: 2
# capability:
# suppress_4_byte_as: true
# description: Test_BGP_PEER_TEMPLATE_1
# local_as: "65536"
# remote_as: "65001"
#
# - name: neighbor_tmplt_2
# description: Test_BGP_PEER_TEMPLATE_2
# address_family:
# - afi: ipv4
# safi: multicast
# advertise_map:
# exist_map: emap1
# route_map: rmap1
# as_override: true
# filter_list:
# inbound: flist1
# outbound: flist2
# inherit:
# peer_session: psession1
# timers:
# holdtime: 100
# keepalive: 45
# After state:
# --------------
#
# nxos9k# show running-config | section "^router bgp"
# router bgp 65536
# template peer neighbor_tmplt_1
# capability suppress 4-byte-as
# bmp-activate-server 2
# description Test_BGP_PEER_TEMPLATE_1
# local-as 65536
# remote-as 65001
# address-family ipv4 unicast
# advertise-map rmap1 non-exist-map nemap1
# advertisement-interval 60
# disable-peer-as-check
# template peer neighbor_tmplt_2
# description Test_BGP_PEER_TEMPLATE_2
# inherit peer-session psession1
# timers 45 100
# address-family ipv4 multicast
# advertise-map rmap1 exist-map emap1
# as-override
# filter-list flist1 in
# filter-list flist2 out
# Using replaced
# Before state:
# -------------
#
# nxos9k# show running-config | section "^router bgp"
# router bgp 65536
# template peer neighbor_tmplt_1
# capability suppress 4-byte-as
# description Test_BGP_PEER_TEMPLATE_1
# bmp-activate-server 2
# local-as 65536
# remote-as 65001
# address-family ipv4 unicast
# advertise-map rmap1 non-exist-map nemap1
# advertisement-interval 60
# disable-peer-as-check
# template peer neighbor_tmplt_2
# description Test_BGP_PEER_TEMPLATE_2
# inherit peer-session psession1
# timers 45 100
# address-family ipv4 multicast
# advertise-map rmap1 exist-map emap1
# as-override
# filter-list flist1 in
# filter-list flist2 out
- name: Replace BGP templates configuration with provided configuration
cisco.nxos.nxos_bgp_templates:
config:
as_number: 65536
neighbor:
- name: neighbor_tmplt_1
address_family:
- afi: ipv4
safi: unicast
advertise_map:
route_map: rmap1
non_exist_map: nemap1
advertisement_interval: 60
disable_peer_as_check: true
inherit:
peer_session: psession1
description: Test_BGP_PEER_TEMPLATE_1
local_as: 65537
state: replaced
# Task output:
# ------------
#
# before:
# as_number: "65536"
# neighbor:
# - name: neighbor_tmplt_1
# address_family:
# - afi: ipv4
# safi: unicast
# advertise_map:
# non_exist_map: nemap1
# route_map: rmap1
# advertisement_interval: 60
# disable_peer_as_check: true
# bmp_activate_server: 2
# capability:
# suppress_4_byte_as: true
# description: Test_BGP_PEER_TEMPLATE_1
# local_as: "65536"
# remote_as: "65001"
#
# - name: neighbor_tmplt_2
# description: Test_BGP_PEER_TEMPLATE_2
# address_family:
# - afi: ipv4
# safi: multicast
# advertise_map:
# exist_map: emap1
# route_map: rmap1
# as_override: true
# filter_list:
# inbound: flist1
# outbound: flist2
# inherit:
# peer_session: psession1
# timers:
# holdtime: 100
# keepalive: 45
#
# commands:
# - router bgp 65536
# - template peer neighbor_tmplt_1
# - no bmp-activate-server 2
# - no capability suppress 4-byte-as
# - inherit peer-session psession1
# - local-as 65537
# - no remote-as 65001
#
# after:
# as_number: "65536"
# neighbor:
# - name: neighbor_tmplt_1
# address_family:
# - afi: ipv4
# safi: unicast
# advertise_map:
# non_exist_map: nemap1
# route_map: rmap1
# advertisement_interval: 60
# disable_peer_as_check: true
# description: Test_BGP_PEER_TEMPLATE_1
# inherit:
# peer_session: psession1
# local_as: "65537"
#
# - name: neighbor_tmplt_2
# description: Test_BGP_PEER_TEMPLATE_2
# address_family:
# - afi: ipv4
# safi: multicast
# advertise_map:
# exist_map: emap1
# route_map: rmap1
# as_override: true
# filter_list:
# inbound: flist1
# outbound: flist2
# inherit:
# peer_session: psession1
# timers:
# holdtime: 100
# keepalive: 45
# After state:
# ------------
#
# nxos9k# show running-config | section "^router bgp"
# router bgp 65536
# template peer neighbor_tmplt_1
# inherit peer-session psession1
# description Test_BGP_PEER_TEMPLATE_1
# local-as 65537
# address-family ipv4 unicast
# advertise-map rmap1 non-exist-map nemap1
# advertisement-interval 60
# disable-peer-as-check
# template peer neighbor_tmplt_2
# description Test_BGP_PEER_TEMPLATE_2
# inherit peer-session psession1
# bmp-activate-server 2
# timers 45 100
# address-family ipv4 multicast
# advertise-map rmap1 exist-map emap1
# as-override
# filter-list flist1 in
# filter-list flist2 out
# Using overridden
#
# Before state:
# -------------
#
# nxos9k# show running-config | section "^router bgp"
# router bgp 65536
# template peer neighbor_tmplt_1
# capability suppress 4-byte-as
# description Test_BGP_PEER_TEMPLATE_1
# bmp-activate-server 2
# local-as 65536
# remote-as 65001
# address-family ipv4 unicast
# advertise-map rmap1 non-exist-map nemap1
# advertisement-interval 60
# disable-peer-as-check
# template peer neighbor_tmplt_2
# description Test_BGP_PEER_TEMPLATE_2
# inherit peer-session psession1
# timers 45 100
# address-family ipv4 multicast
# advertise-map rmap1 exist-map emap1
# as-override
# filter-list flist1 in
# filter-list flist2 out
- name: Override BGP templates configuration with provided configuration
cisco.nxos.nxos_bgp_templates:
config:
as_number: 65536
neighbor:
- name: neighbor_tmplt_1
address_family:
- afi: ipv4
safi: unicast
advertise_map:
route_map: rmap1
non_exist_map: nemap1
advertisement_interval: 60
disable_peer_as_check: true
inherit:
peer_session: psession1
description: Test_BGP_PEER_TEMPLATE_1
local_as: 65537
state: overridden
# Task output:
# ------------
#
# before:
# as_number: "65536"
# neighbor:
# - name: neighbor_tmplt_1
# address_family:
# - afi: ipv4
# safi: unicast
# advertise_map:
# non_exist_map: nemap1
# route_map: rmap1
# advertisement_interval: 60
# disable_peer_as_check: true
# bmp_activate_server: 2
# capability:
# suppress_4_byte_as: true
# description: Test_BGP_PEER_TEMPLATE_1
# local_as: "65536"
# remote_as: "65001"
#
# - name: neighbor_tmplt_2
# description: Test_BGP_PEER_TEMPLATE_2
# address_family:
# - afi: ipv4
# safi: multicast
# advertise_map:
# exist_map: emap1
# route_map: rmap1
# as_override: true
# filter_list:
# inbound: flist1
# outbound: flist2
# inherit:
# peer_session: psession1
# timers:
# holdtime: 100
# keepalive: 45
#
# commands:
# - router bgp 65536
# - template peer neighbor_tmplt_1
# - no bmp-activate-server 2
# - no capability suppress 4-byte-as
# - inherit peer-session psession1
# - local-as 65537
# - no remote-as 65001
# - no template peer neighbor_tmplt_2
#
# after:
# as_number: "65536"
# neighbor:
# - name: neighbor_tmplt_1
# address_family:
# - afi: ipv4
# safi: unicast
# advertise_map:
# non_exist_map: nemap1
# route_map: rmap1
# advertisement_interval: 60
# disable_peer_as_check: true
# description: Test_BGP_PEER_TEMPLATE_1
# inherit:
# peer_session: psession1
# local_as: "65537"
# After state:
# ------------
#
# nxos9k# show running-config | section "^router bgp"
# router bgp 65536
# template peer neighbor_tmplt_1
# inherit peer-session psession1
# description Test_BGP_PEER_TEMPLATE_1
# local-as 65537
# address-family ipv4 unicast
# advertise-map rmap1 non-exist-map nemap1
# advertisement-interval 60
# disable-peer-as-check
# Using deleted
# Before state:
# --------------
#
# nxos9k# show running-config | section "^router bgp"
# router bgp 65536
# template peer neighbor_tmplt_1
# capability suppress 4-byte-as
# description Test_BGP_PEER_TEMPLATE_1
# bmp-activate-server 2
# local-as 65536
# remote-as 65001
# address-family ipv4 unicast
# advertise-map rmap1 non-exist-map nemap1
# advertisement-interval 60
# disable-peer-as-check
# template peer neighbor_tmplt_2
# description Test_BGP_PEER_TEMPLATE_2
# inherit peer-session psession1
# timers 45 100
# address-family ipv4 multicast
# advertise-map rmap1 exist-map emap1
# as-override
# filter-list flist1 in
# filter-list flist2 out
- name: Delete BGP configs handled by this module
cisco.nxos.nxos_bgp_templates:
state: deleted
# Task output:
# ------------
#
# before:
# as_number: "65536"
# neighbor:
# - name: neighbor_tmplt_1
# address_family:
# - afi: ipv4
# safi: unicast
# advertise_map:
# non_exist_map: nemap1
# route_map: rmap1
# advertisement_interval: 60
# disable_peer_as_check: true
# bmp_activate_server: 2
# capability:
# suppress_4_byte_as: true
# description: Test_BGP_PEER_TEMPLATE_1
# local_as: "65536"
# remote_as: "65001"
#
# - name: neighbor_tmplt_2
# description: Test_BGP_PEER_TEMPLATE_2
# address_family:
# - afi: ipv4
# safi: multicast
# advertise_map:
# exist_map: emap1
# route_map: rmap1
# as_override: true
# filter_list:
# inbound: flist1
# outbound: flist2
# inherit:
# peer_session: psession1
# timers:
# holdtime: 100
# keepalive: 45
#
# commands:
# - router bgp 65536
# - no template peer neighbor_tmplt_1
# - no template peer neighbor_tmplt_2
#
# after: {}
# After state:
# -------------
# nxos9k# show running-config | section "^router bgp"
# nxos9k#
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
after dictionary | Конфигурация после выполнения модуля. Возвращается: при изменении Пример: |
before dictionary | Конфигурация до выполнения модуля. Возвращается: если state имеет значение Пример: |
commands list / elements=string | Набор команд, отправленных на удалённое устройство. Возвращается: если state имеет значение Пример: |
gathered dictionary | Сведения о сетевом ресурсе, собранные с удалённого устройства в виде структурированных данных. Возвращается: если state имеет значение Пример: |
parsed dictionary | Встроенная конфигурация устройства, указанная в параметре running_config и разобранная в структурированные данные согласно спецификации аргументов модуля. Возвращается: если state имеет значение Пример: |
rendered list / elements=string | Переданная в задаче конфигурация, преобразованная в формат команд устройства (автономный режим). Возвращается: если state имеет значение Пример: |
Ссылки на коллекцию
© 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/nxos/nxos_bgp_templates_module.html