Модуль cisco.nxos.nxos_bgp_templates – Модуль ресурсов шаблонов BGP.

Примечание

Этот модуль входит в коллекцию cisco.nxos (версия 8.1.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	Указание карты маршрутов для условной рекламы.
exist_map string	Условная карта маршрутов для рекламы только тогда, когда префикс в условии существует.
non_exist_map string	Условная карта маршрутов для рекламы только тогда, когда префикс в условии не существует.
route_map string / required	Имя карты маршрутов.
advertisement_interval integer	Минимальный интервал между отправкой обновлений маршрутизации BGP.
afi string / required	Индикатор семейства адресов. Варианты: `"ipv4"` `"ipv6"` `"link-state"` `"l2vpn"`
allowas_in dictionary	Принимать as-path с моим AS, присутствующим в нем.
max_occurences integer	Количество вхождений номера AS, по умолчанию 3.
set boolean	Активировать свойство allowas-in. Варианты: `false` `true`
as_override boolean	Переопределить совпадающий номер AS при отправке обновления. Варианты: `false` `true`
capability dictionary	Рекламировать возможности пиру.
additional_paths dictionary	Возможность дополнительных путей.
receive string	Возможность приема дополнительных путей. Варианты: `"enable"` `"disable"`
send string	Возможность отправки дополнительных путей. Варианты: `"enable"` `"disable"`
default_originate dictionary	Генерировать значение по умолчанию для этого пира.
route_map string	Карта маршрутов для указания критериев генерации значения по умолчанию.
set boolean	Установить атрибут default-originate. Варианты: `false` `true`
disable_peer_as_check boolean	Отключить проверку номера AS пира при рекламе. Варианты: `false` `true`
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	Выводить только предупреждающее сообщение при превышении лимита. Choices: `false` `true`
next_hop_self dictionary	Установить наш адрес как next-hop (без отражения).
all_routes boolean	Установить наш адрес как next-hop для всех маршрутов. Choices: `false` `true`
set boolean	Установить атрибут next-hop-self. Choices: `false` `true`
next_hop_third_party boolean	Вычислить next-hop третьей стороны, если возможно. Choices: `false` `true`
prefix_list dictionary	Применить список префиксов.
inbound string	Применить политику к входящим маршрутам.
outbound string	Применить политику к исходящим маршрутам.
route_map dictionary	Применить карту маршрутов к соседу.
inbound string	Имя политики для применения к входящим маршрутам.
outbound string	Имя политики для применения к исходящим маршрутам.
route_reflector_client boolean	Настроить соседа как клиента отражателя маршрутов. Choices: `false` `true`
safi string	Индикатор дополнительного семейства адресов. Choices: `"unicast"` `"multicast"` `"mvpn"` `"evpn"`
send_community string	Отправить атрибут сообщества этому соседу. Choices: `"standard"` `"extended"` `"both"`
soft_reconfiguration_inbound dictionary	Мягкая переконфигурация.

always boolean	Всегда выполнять входящую мягкую переконфигурацию. Choices: `false` `true`
set boolean	Установить атрибут входящей мягкой переконфигурации. Choices: `false` `true`
soo string	Указать extcommunity места происхождения.
suppress_inactive boolean	Объявлять только активные маршруты пиру. Choices: `false` `true`
unsuppress_map string	Карта маршрутов для выборочного отмены подавления подавленных маршрутов.
weight integer	Установить вес по умолчанию для маршрутов от этого соседа.
bfd dictionary	Двунаправленное быстрое обнаружение для соседа.
multihop dictionary	Многоходовой сеанс.
interval dictionary	Настроить параметры интервала сеанса BFD.
min_rx_interval integer / required	Минимальный интервал RX.
multiplier integer / required	Множитель обнаружения.
tx_interval integer / required	TX интервал в миллисекундах.
set boolean	Установить многоходовой BFD. Choices: `false` `true`
set boolean	Установить BFD для этого соседа. Choices: `false` `true`
singlehop boolean	Одноходовой сеанс. Choices: `false` `true`
bmp_activate_server integer	Указать идентификатор сервера для активации мониторинга BMP для пира.
capability dictionary	Возможность.
suppress_4_byte_as boolean	Подавить возможность 4-байтового AS. Choices: `false` `true`
description string	Описание, специфичное для соседа.
disable_connected_check boolean	Отключить проверку на непосредственно подключенного пира. Choices: `false` `true`
dont_capability_negotiate boolean	Не вести переговоры о возможностях с этим соседом. Choices: `false` `true`
dscp string	Установить значение DSCP для TCP-транспорта.
dynamic_capability boolean	Динамическая возможность Choices: `false` `true`

ebgp_multihop integer	Укажите многоходовое значение TTL для удаленного пира.
graceful_shutdown dictionary	Graceful-shutdown для этого соседа.
activate dictionary	Отправить сообщество graceful-shutdown.
route_map string	Применить route-map для изменения атрибутов для исходящих данных.
set boolean	Установить activate. Choices: `false` `true`
inherit dictionary	Наследовать шаблон.
peer_session string	Шаблон peer-session для наследования.
local_as string	Укажите номер local-as для соседа eBGP.
log_neighbor_changes dictionary	Сообщение журнала для события перехода соседа в состояние «вверх/вниз».
disable boolean	Отключить ведение журнала событий перехода соседа в состояние «вверх/вниз». Choices: `false` `true`
set boolean	Установить log-neighbor-changes. Choices: `false` `true`
low_memory dictionary	Поведение в ситуациях с низким объемом памяти.
exempt boolean	Не отключать этого пира при низком уровне памяти. Choices: `false` `true`
name string	Имя шаблона пира BGP.
password dictionary	Настроить пароль для соседа.
encryption integer	0 указывает на незашифрованный пароль соседа. 3 указывает, что будет следовать зашифрованный пароль соседа 3DES. 7 указывает, что будет следовать зашифрованный пароль соседа типа Cisco 7.
key string	Пароль аутентификации.
path_attribute list / elements=dictionary	Необязательная фильтрация атрибутов пути BGP.
action string	Действие. Choices: `"discard"` `"treat-as-withdraw"`
range dictionary	Диапазон атрибутов пути.
end integer	Конечное значение диапазона атрибутов пути.
start integer	Начальное значение диапазона атрибутов пути.
type integer	Тип атрибута пути
remote_as string	Укажите номер автономной системы соседа.
remove_private_as dictionary	Удалить частный номер AS из исходящих обновлений.

all boolean	Все. Варианты: `false` `true`
replace_as boolean	Заменить. Варианты: `false` `true`
set boolean	Удалить частный AS. Варианты: `false` `true`
shutdown boolean	Административно отключить этого соседа. Варианты: `false` `true`
timers dictionary	Настройка таймеров keepalive и hold.
holdtime integer	Время удержания (секунды).
keepalive integer	Интервал keepalive (секунды).
transport dictionary	BGP транспортное соединение.
connection_mode dictionary	Укажите тип соединения.
passive boolean	Разрешить только пассивное подключение. Варианты: `false` `true`
ttl_security dictionary	Включить механизм безопасности TTL.
hops integer	Укажите количество хопов для удаленного узла.
update_source string	Укажите источник BGP сессии и обновлений.
running_config string	Этот параметр используется только со state parsed. Значение этого параметра должно быть результатом выполнения команды show running-config bgp \| section ‘template’ на устройстве NX-OS. State parsed считывает конфигурацию из параметра `running_config` и преобразует ее в структурированные данные Ansible в соответствии с argspec модуля ресурса, а затем возвращает значение в ключе parsed в результате.
state string	Состояние, в котором должна быть оставлена конфигурация. Дополнительные сведения см. в примерах. Варианты: `"merged"` ← (по умолчанию) `"replaced"` `"overridden"` `"deleted"` `"parsed"` `"gathered"` `"rendered"`

Примечания

Примечание

Проверено на 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#

END_OF_DOCUMENT_MARKER

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

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

Ключ	Описание
after словарь	Результирующая конфигурация после выполнения модуля. Возвращается: при изменении Пример: `"This output will always be in the same format as the module argspec.\n"`
before словарь	Конфигурация до выполнения модуля. Возвращается: когда state равен `merged`, `replaced`, `overridden`, `deleted` или `purged` Пример: `"This output will always be in the same format as the module argspec.\n"`
commands список / элементы=строка	Набор команд, отправленных на удалённое устройство. Возвращается: когда state равен `merged`, `replaced`, `overridden`, `deleted` или `purged` Пример: `["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"]`
gathered словарь	Данные о сетевом ресурсе, собранные с удалённого устройства в виде структурированных данных. Возвращается: когда state равен `gathered` Пример: `"This output will always be in the same format as the module argspec.\n"`
parsed словарь	Родная конфигурация устройства, предоставленная в параметре running_config, разобранная в структурированные данные в соответствии с параметрами модуля argspec. Возвращается: когда state равен `parsed` Пример: `"This output will always be in the same format as the module argspec.\n"`
rendered список / элементы=строка	Предоставленная конфигурация в задании, преобразованная в формат, понятный устройству (офлайн). Возвращается: когда state равен `rendered` Пример: `["router bgp 65536", "template peer neighbor_tmplt_1", "bmp-activate-server 2", "no capability suppress 4-byte-as", "no template peer neighbor_tmplt_2"]`

Авторы

Nilashish Chakraborty (@NilashishC)

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

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/nxos/nxos_bgp_templates_module.html