cisco.nxos.nxos_bgp_neighbor_address_family module – модуль ресурсов семейства адресов соседа BGP.

Примечание

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

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

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

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

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

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

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

Этот модуль управляет конфигурацией семейства адресов соседа BGP на устройствах под управлением Cisco NX-OS.

Примечание

Этому модулю соответствует плагин действий.

Параметры

Параметр	Комментарии
config dictionary	Конфигурация семейства адресов соседа BGP.
as_number string	Номер автономной системы маршрутизатора.
neighbors list / elements=dictionary	Список конфигураций семейства адресов соседей BGP.
address_family list / elements=dictionary	Настройки семейства адресов соседа BGP.
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 / обязательный	Идентификатор семейства адресов. Варианты: `"ipv4"` `"ipv6"` `"link-state"` `"vpnv4"` `"vpnv6"` `"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	Route-map для задания критериев анонсирования маршрута по умолчанию.
set boolean	Установить атрибут default-originate. Варианты: `false` `true`
disable_peer_as_check boolean	Отключить проверку номера AS соседа при анонсировании. Варианты: `false` `true`
filter_list dictionary	Имя списка фильтров.
inbound string	Применить политику к входящим маршрутам.
outbound string	Применить политику к исходящим маршрутам.
inherit dictionary	Наследовать шаблон.
sequence integer	Порядковый номер.
template string	Имя шаблона.
maximum_prefix dictionary	Максимальное количество префиксов от этого соседа.
generate_warning_threshold integer	Пороговое значение в процентах для выдачи предупреждения.
max_prefix_limit integer	Максимальный предел количества префиксов.
restart_interval integer	Перезапустить соединение BGP после превышения предела.
warning_only boolean	Только выдавать предупреждение при превышении предела. Варианты: `false` `true`
next_hop_self dictionary	Указать наш адрес в качестве следующего узла (для неотражённых маршрутов).
all_routes boolean	Указать наш адрес в качестве следующего узла для всех маршрутов. Варианты: `false` `true`
set boolean	Установить атрибут next-hop-self. Варианты: `false` `true`
next_hop_third_party boolean	Вычислить адрес следующего узла третьей стороны, если это возможно. Варианты: `false` `true`
prefix_list dictionary	Применить список префиксов.
inbound string	Применить политику к входящим маршрутам.
outbound string	Применить политику к исходящим маршрутам.
rewrite_evpn_rt_asn boolean	Автоматически создавать RT для соседа EBGP. Варианты: `false` `true`
rewrite_rt_asn boolean	Автоматически создавать RT для соседа EBGP. Варианты: `false` `true`
route_map dictionary	Применить route-map к соседу.
inbound string	Применить политику к входящим маршрутам.
outbound string	Применить политику к исходящим маршрутам.
route_reflector_client boolean	Настроить соседа в качестве клиента route reflector. Варианты: `false` `true`
safi string	Идентификатор подсемейства адресов. Варианты: `"unicast"` `"multicast"` `"mvpn"` `"evpn"`
send_community dictionary	Отправлять этому соседу атрибут Community.
both boolean	Отправлять стандартные и расширенные атрибуты Community. Варианты: `false` `true`
extended boolean	Отправлять расширенный атрибут Community. Варианты: `false` `true`
set boolean	Установить атрибут send-community. Варианты: `false` `true`
standard boolean	Отправлять стандартный атрибут Community. Варианты: `false` `true`
soft_reconfiguration_inbound dictionary	Мягкая реконфигурация.
always boolean	Всегда выполнять мягкую входящую реконфигурацию. Варианты: `false` `true`
set boolean	Установить атрибут soft-reconfiguration inbound. Варианты: `false` `true`
soo string	Указать расширенное сообщество Site-of-Origin.
suppress_inactive boolean	Анонсировать соседу только активные маршруты. Варианты: `false` `true`
unsuppress_map string	Route-map для выборочного снятия подавления с маршрутов.
weight integer	Задать вес по умолчанию для маршрутов от этого соседа.

neighbor_address string / required	IP- или IPv6-адрес соседа.
vrfs list / elements=dictionary	Контекст виртуального маршрутизатора.
neighbors list / elements=dictionary	Список конфигураций семейств адресов (AF) соседей BGP.
address_family list / elements=dictionary	Конфигурации, относящиеся к семейству адресов соседа BGP.
advertise_map dictionary	Укажите route-map для условной рекламы маршрутов.
exist_map string	Условный route-map для рекламы маршрута, только если префикс, указанный в условии, существует.
non_exist_map string	Условный route-map для рекламы маршрута, только если префикс, указанный в условии, отсутствует.
route_map string / required	Имя route-map.
advertisement_interval integer	Минимальный интервал между отправкой обновлений маршрутизации BGP.
afi string / required	Идентификатор семейства адресов. Варианты: `"ipv4"` `"ipv6"` `"link-state"` `"vpnv4"` `"vpnv6"` `"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	Route-map для указания критериев анонсирования маршрута по умолчанию.
set boolean	Установить атрибут default-originate. Варианты: `false` `true`
disable_peer_as_check boolean	Отключить проверку номера AS соседа при анонсировании. Варианты: `false` `true`
filter_list dictionary	Имя списка фильтров.
inbound string	Применить политику к входящим маршрутам.
outbound string	Применить политику к исходящим маршрутам.
inherit dictionary	Наследовать шаблон.
sequence integer	Номер последовательности.
template string	Имя шаблона.
maximum_prefix dictionary	Максимальное количество префиксов от этого соседа.
generate_warning_threshold integer	Пороговое значение в процентах, при достижении которого выводится предупреждение.
max_prefix_limit integer	Максимальное количество префиксов.
restart_interval integer	Перезапустить соединение BGP после превышения лимита.
warning_only boolean	При превышении лимита выводить только предупреждение. Варианты: `false` `true`
next_hop_self dictionary	Указать наш адрес в качестве следующего узла (неотражённый маршрут).
all_routes boolean	Указывать наш адрес в качестве следующего узла для всех маршрутов. Варианты: `false` `true`
set boolean	Установить атрибут next-hop-self. Варианты: `false` `true`
next_hop_third_party boolean	Вычислять адрес следующего узла третьей стороны, если возможно. Варианты: `false` `true`
prefix_list dictionary	Применить список префиксов.
inbound string	Применить политику к входящим маршрутам.
outbound string	Применить политику к исходящим маршрутам.
rewrite_evpn_rt_asn boolean	Автоматически создавать RT для соседа EBGP. Варианты: `false` `true`
rewrite_rt_asn boolean	Автоматически создавать RT для соседа EBGP. Варианты: `false` `true`
route_map dictionary	Применить route-map к соседу.
inbound string	Применить политику к входящим маршрутам.
outbound string	Применить политику к исходящим маршрутам.
route_reflector_client boolean	Настроить соседа как клиента Route Reflector. Варианты: `false` `true`
safi string	Идентификатор подсемейства адресов. Варианты: `"unicast"` `"multicast"` `"mvpn"` `"evpn"`
send_community dictionary	Отправлять атрибут Community этому соседу.
both boolean	Отправлять атрибуты Standard и Extended Community. Варианты: `false` `true`
extended boolean	Отправлять атрибут Extended Community. Варианты: `false` `true`
set boolean	Установить атрибут send-community. Варианты: `false` `true`
standard boolean	Отправлять атрибут Standard Community. Варианты: `false` `true`
soft_reconfiguration_inbound dictionary	Мягкая реконфигурация.
always boolean	Всегда выполнять мягкую реконфигурацию входящих маршрутов. Варианты: `false` `true`
set boolean	Установить атрибут soft-reconfiguration inbound. Варианты: `false` `true`
soo string	Указать расширенное сообщество Site-of-Origin.
suppress_inactive boolean	Анонсировать соседу только активные маршруты. Варианты: `false` `true`
unsuppress_map string	Route-map для выборочного снятия подавления с маршрутов.
weight integer	Установить вес по умолчанию для маршрутов от этого соседа.

neighbor_address string / required	IP/IPv6-адрес соседа.
vrf string	Имя VRF.
running_config string	Этот параметр используется только со значением состояния parsed. Значением этого параметра должен быть вывод, полученный с устройства NX-OS при выполнении команды show running-config \| section ‘^router bgp’. Состояние parsed считывает конфигурацию из параметра `running_config` и преобразует её в структурированные данные Ansible в соответствии со спецификацией аргументов модуля ресурса, после чего значение возвращается в ключе parsed в составе результата.
state string	Состояние, в котором должна остаться конфигурация. Состояние deleted удаляет только атрибуты BGP, управляемые этим модулем, и не отключает процесс BGP целиком. Дополнительные сведения см. в примерах. Варианты: `"merged"` ← (по умолчанию) `"replaced"` `"overridden"` `"deleted"` `"parsed"` `"gathered"` `"rendered"`

Примечания

Примечание

Проверено на NX-OS 9.3.6.
Не поддерживается для Cisco MDS
Для управления конфигурациями семейств адресов BGP используйте модуль cisco.nxos.nxos_bgp_address_family.
Этот модуль работает с подключениями network_cli и httpapi.

Примеры

# Using merged

# Before state:
# -------------
# Nexus9000v# show running-config | section "^router bgp"
# Nexus9000v#

- name: Merge the provided configuration with the existing running configuration
  cisco.nxos.nxos_bgp_neighbor_address_family: &id001
    config:
      as_number: 65536
      neighbors:
        - neighbor_address: 192.0.2.32
          address_family:
            - afi: ipv4
              safi: unicast
              maximum_prefix:
                max_prefix_limit: 20
                generate_warning_threshold: 75
              weight: 100
              prefix_list:
                inbound: rmap1
                outbound: rmap2
            - afi: ipv6
              safi: unicast
        - neighbor_address: 192.0.2.33
          address_family:
            - afi: ipv4
              safi: multicast
              inherit:
                template: BasePolicy
                sequence: 200
      vrfs:
        - vrf: site-1
          neighbors:
            - neighbor_address: 203.0.113.1
              address_family:
                - afi: ipv4
                  safi: unicast
                  suppress_inactive: true
                  next_hop_self:
                    set: true
            - neighbor_address: 203.0.113.2
              address_family:
                - afi: ipv6
                  safi: unicast
                - afi: ipv4
                  safi: multicast
                  send_community:
                    set: true

# Task output:
# ------------
#  before: {}
#
#  commands:
#  - router bgp 65536
#  - neighbor 192.0.2.32
#  - address-family ipv4 unicast
#  - maximum-prefix 20 75
#  - weight 100
#  - prefix-list rmap1 in
#  - prefix-list rmap2 out
#  - address-family ipv6 unicast
#  - neighbor 192.0.2.33
#  - address-family ipv4 multicast
#  - inherit peer-policy BasePolicy 200
#  - vrf site-1
#  - neighbor 203.0.113.1
#  - address-family ipv4 unicast
#  - suppress-inactive
#  - next-hop-self
#  - neighbor 203.0.113.2
#  - address-family ipv6 unicast
#  - address-family ipv4 multicast
#  - send-community
#
#  after:
#    as_number: "65536"
#    neighbors:
#      - neighbor_address: 192.0.2.32
#        address_family:
#          - afi: ipv4
#            safi: unicast
#            maximum_prefix:
#              max_prefix_limit: 20
#              generate_warning_threshold: 75
#            weight: 100
#            prefix_list:
#              inbound: rmap1
#              outbound: rmap2
#          - afi: ipv6
#            safi: unicast
#      - neighbor_address: 192.0.2.33
#        address_family:
#          - afi: ipv4
#            safi: multicast
#            inherit:
#              template: BasePolicy
#              sequence: 200
#    vrfs:
#      - vrf: site-1
#        neighbors:
#          - neighbor_address: 203.0.113.1
#            address_family:
#              - afi: ipv4
#                safi: unicast
#                suppress_inactive: true
#                next_hop_self:
#                  set: true
#          - neighbor_address: 203.0.113.2
#            address_family:
#              - afi: ipv4
#                safi: multicast
#                send_community:
#                  set: true
#              - afi: ipv6
#                safi: unicast

# After state:
# ------------
# Nexus9000v# show running-config | section "^router bgp"
# router bgp 65536
#   neighbor 192.0.2.32
#     address-family ipv4 unicast
#       maximum-prefix 20 75
#       weight 100
#       prefix-list rmap1 in
#       prefix-list rmap2 out
#     address-family ipv6 unicast
#   neighbor 192.0.2.33
#     address-family ipv4 multicast
#       inherit peer-policy BasePolicy 200
#   vrf site-1
#     neighbor 203.0.113.1
#       address-family ipv4 unicast
#         suppress-inactive
#         next-hop-self
#     neighbor 203.0.113.2
#       address-family ipv4 multicast
#         send-community
#       address-family ipv6 unicast
#

# Using replaced

# Before state:
# -------------
# Nexus9000v# show running-config | section "^router bgp"
# router bgp 65536
#   neighbor 192.0.2.32
#     address-family ipv4 unicast
#       maximum-prefix 20 75
#       weight 100
#       prefix-list rmap1 in
#       prefix-list rmap2 out
#     address-family ipv6 unicast
#   neighbor 192.0.2.33
#     address-family ipv4 multicast
#       inherit peer-policy BasePolicy 200
#   vrf site-1
#     neighbor 203.0.113.1
#       address-family ipv4 unicast
#         suppress-inactive
#         next-hop-self
#     neighbor 203.0.113.2
#       address-family ipv4 multicast
#         send-community
#       address-family ipv6 unicast
#

- name: Replace specified neighbor AFs with given configuration
  cisco.nxos.nxos_bgp_neighbor_address_family: &replaced
    config:
      as_number: 65536
      neighbors:
        - neighbor_address: 192.0.2.32
          address_family:
            - afi: ipv4
              safi: unicast
              weight: 110
            - afi: ipv6
              safi: unicast
        - neighbor_address: 192.0.2.33
          address_family:
            - afi: ipv4
              safi: multicast
              inherit:
                template: BasePolicy
                sequence: 200
      vrfs:
        - vrf: site-1
          neighbors:
            - neighbor_address: 203.0.113.1
              address_family:
                - afi: ipv4
                  safi: unicast
            - neighbor_address: 203.0.113.2
              address_family:
                - afi: ipv6
                  safi: unicast
                - afi: ipv4
                  safi: multicast
                  send_community:
                    set: true
    state: replaced

# Task output:
# ------------
#  before:
#    as_number: "65536"
#    neighbors:
#      - neighbor_address: 192.0.2.32
#        address_family:
#          - afi: ipv4
#            safi: unicast
#            maximum_prefix:
#              max_prefix_limit: 20
#              generate_warning_threshold: 75
#            weight: 100
#            prefix_list:
#              inbound: rmap1
#              outbound: rmap2
#          - afi: ipv6
#            safi: unicast
#      - neighbor_address: 192.0.2.33
#        address_family:
#          - afi: ipv4
#            safi: multicast
#            inherit:
#              template: BasePolicy
#              sequence: 200
#    vrfs:
#      - vrf: site-1
#        neighbors:
#          - neighbor_address: 203.0.113.1
#            address_family:
#              - afi: ipv4
#                safi: unicast
#                suppress_inactive: true
#                next_hop_self:
#                  set: true
#          - neighbor_address: 203.0.113.2
#            address_family:
#              - afi: ipv4
#                safi: multicast
#                send_community:
#                  set: true
#              - afi: ipv6
#                safi: unicast
#
#  commands:
#    - router bgp 65536
#    - neighbor 192.0.2.32
#    - address-family ipv4 unicast
#    - no maximum-prefix 20 75
#    - weight 110
#    - no prefix-list rmap1 in
#    - no prefix-list rmap2 out
#    - vrf site-1
#    - neighbor 203.0.113.1
#    - address-family ipv4 unicast
#    - no suppress-inactive
#    - no next-hop-self
#
#  after:
#    as_number: "65536"
#    neighbors:
#      - neighbor_address: 192.0.2.32
#        address_family:
#          - afi: ipv4
#            safi: unicast
#            weight: 110
#          - afi: ipv6
#            safi: unicast
#      - neighbor_address: 192.0.2.33
#        address_family:
#          - afi: ipv4
#            safi: multicast
#            inherit:
#              template: BasePolicy
#              sequence: 200
#    vrfs:
#      - vrf: site-1
#        neighbors:
#          - neighbor_address: 203.0.113.1
#            address_family:
#              - afi: ipv4
#                safi: unicast
#          - neighbor_address: 203.0.113.2
#            address_family:
#              - afi: ipv4
#                safi: multicast
#                send_community:
#                  set: true
#              - afi: ipv6
#                safi: unicast

# After state:
# ------------
# Nexus9000v# show running-config | section "^router bgp"
# router bgp 65536
#   neighbor 192.0.2.32
#     address-family ipv4 unicast
#       weight 110
#     address-family ipv6 unicast
#   neighbor 192.0.2.33
#     address-family ipv4 multicast
#       inherit peer-policy BasePolicy 200
#   vrf site-1
#     neighbor 203.0.113.1
#       address-family ipv4 unicast
#     neighbor 203.0.113.2
#       address-family ipv4 multicast
#         send-community
#       address-family ipv6 unicast
#

# Using overridden

# Before state:
# -------------
# Nexus9000v# show running-config | section "^router bgp"
# router bgp 65536
#   neighbor 192.0.2.32
#     address-family ipv4 unicast
#       maximum-prefix 20 75
#       weight 100
#       prefix-list rmap1 in
#       prefix-list rmap2 out
#     address-family ipv6 unicast
#   neighbor 192.0.2.33
#     address-family ipv4 multicast
#       inherit peer-policy BasePolicy 200
#   vrf site-1
#     neighbor 203.0.113.1
#       address-family ipv4 unicast
#         suppress-inactive
#         next-hop-self
#     neighbor 203.0.113.2
#       address-family ipv4 multicast
#         send-community
#       address-family ipv6 unicast
#

- name: Override all BGP AF configuration with provided configuration
  cisco.nxos.nxos_bgp_neighbor_address_family:
    config:
      as_number: 65536
      neighbors:
        - neighbor_address: 192.0.2.32
          address_family:
            - afi: ipv4
              safi: unicast
      vrfs:
        - vrf: site-1
          neighbors:
            - neighbor_address: 203.0.113.1
              address_family:
                - afi: ipv4
                  safi: unicast
                  suppress_inactive: true
                  next_hop_self:
                    set: true
    state: overridden

# Task output:
# ------------
#  before:
#    as_number: "65536"
#    neighbors:
#      - neighbor_address: 192.0.2.32
#        address_family:
#          - afi: ipv4
#            safi: unicast
#            maximum_prefix:
#              max_prefix_limit: 20
#              generate_warning_threshold: 75
#            weight: 100
#            prefix_list:
#              inbound: rmap1
#              outbound: rmap2
#          - afi: ipv6
#            safi: unicast
#      - neighbor_address: 192.0.2.33
#        address_family:
#          - afi: ipv4
#            safi: multicast
#            inherit:
#              template: BasePolicy
#              sequence: 200
#    vrfs:
#      - vrf: site-1
#        neighbors:
#          - neighbor_address: 203.0.113.1
#            address_family:
#              - afi: ipv4
#                safi: unicast
#                suppress_inactive: true
#                next_hop_self:
#                  set: true
#          - neighbor_address: 203.0.113.2
#            address_family:
#              - afi: ipv4
#                safi: multicast
#                send_community:
#                  set: true
#              - afi: ipv6
#                safi: unicast
#
#  commands:
#    - router bgp 65536
#    - neighbor 192.0.2.32
#    - address-family ipv4 unicast
#    - no maximum-prefix 20 75
#    - no weight 100
#    - no prefix-list rmap1 in
#    - no prefix-list rmap2 out
#    - no address-family ipv6 unicast
#    - neighbor 192.0.2.33
#    - no address-family ipv4 multicast
#    - vrf site-1
#    - neighbor 203.0.113.2
#    - no address-family ipv4 multicast
#    - no address-family ipv6 unicast
#
#  after:
#    as_number: "65536"
#    neighbors:
#      - neighbor_address: 192.0.2.32
#        address_family:
#          - afi: ipv4
#            safi: unicast
#    vrfs:
#      - vrf: site-1
#        neighbors:
#          - neighbor_address: 203.0.113.1
#            address_family:
#              - afi: ipv4
#                safi: unicast
#                suppress_inactive: true
#                next_hop_self:
#                  set: true

# After state:
# ------------
# Nexus9000v# show running-config | section "^router bgp"
# router bgp 65536
#   neighbor 192.0.2.32
#     address-family ipv4 unicast
#   vrf site-1
#     neighbor 203.0.113.1
#       address-family ipv4 unicast
#         suppress-inactive
#         next-hop-self

# Using deleted to remove specified neighbor AFs

# Before state:
# -------------
# Nexus9000v# show running-config | section "^router bgp"
# router bgp 65536
#   neighbor 192.0.2.32
#     address-family ipv4 unicast
#       maximum-prefix 20 75
#       weight 100
#       prefix-list rmap1 in
#       prefix-list rmap2 out
#     address-family ipv6 unicast
#   neighbor 192.0.2.33
#     address-family ipv4 multicast
#       inherit peer-policy BasePolicy 200
#   vrf site-1
#     neighbor 203.0.113.1
#       address-family ipv4 unicast
#         suppress-inactive
#         next-hop-self
#     neighbor 203.0.113.2
#       address-family ipv4 multicast
#         send-community
#       address-family ipv6 unicast
#

- name: Delete BGP configs handled by this module
  cisco.nxos.nxos_bgp_neighbor_address_family:
    config:
      as_number: 65536
      neighbors:
        - neighbor_address: 192.0.2.32
          address_family:
            - afi: ipv4
              safi: unicast
      vrfs:
        - vrf: site-1
          neighbors:
            - neighbor_address: 203.0.113.2
              address_family:
                - afi: ipv6
                  safi: unicast
    state: deleted

# Task output:
# ------------
#  before:
#    as_number: "65536"
#    neighbors:
#      - neighbor_address: 192.0.2.32
#        address_family:
#          - afi: ipv4
#            safi: unicast
#            maximum_prefix:
#              max_prefix_limit: 20
#              generate_warning_threshold: 75
#            weight: 100
#            prefix_list:
#              inbound: rmap1
#              outbound: rmap2
#          - afi: ipv6
#            safi: unicast
#      - neighbor_address: 192.0.2.33
#        address_family:
#          - afi: ipv4
#            safi: multicast
#            inherit:
#              template: BasePolicy
#              sequence: 200
#    vrfs:
#      - vrf: site-1
#        neighbors:
#          - neighbor_address: 203.0.113.1
#            address_family:
#              - afi: ipv4
#                safi: unicast
#                suppress_inactive: true
#                next_hop_self:
#                  set: true
#          - neighbor_address: 203.0.113.2
#            address_family:
#              - afi: ipv4
#                safi: multicast
#                send_community:
#                  set: true
#              - afi: ipv6
#                safi: unicast
#
#  commands:
#    - router bgp 65536
#    - neighbor 192.0.2.32
#    - no address-family ipv4 unicast
#    - vrf site-1
#    - neighbor 203.0.113.2
#    - no address-family ipv6 unicast
#
#  after:
#    as_number: "65536"
#    neighbors:
#      - neighbor_address: 192.0.2.32
#        address_family:
#          - afi: ipv6
#            safi: unicast
#      - neighbor_address: 192.0.2.33
#        address_family:
#          - afi: ipv4
#            safi: multicast
#            inherit:
#              template: BasePolicy
#              sequence: 200
#    vrfs:
#      - vrf: site-1
#        neighbors:
#          - neighbor_address: 203.0.113.1
#            address_family:
#              - afi: ipv4
#                safi: unicast
#                suppress_inactive: true
#                next_hop_self:
#                  set: true
#          - neighbor_address: 203.0.113.2
#            address_family:
#              - afi: ipv4
#                safi: multicast
#                send_community:
#                  set: true
#
# After state:
# ------------
# Nexus9000v# show running-config | section "^router bgp"
# router bgp 65536
#   neighbor 192.0.2.32
#     address-family ipv6 unicast
#   neighbor 192.0.2.33
#     address-family ipv4 multicast
#       inherit peer-policy BasePolicy 200
#   vrf site-1
#     neighbor 203.0.113.1
#       address-family ipv4 unicast
#         suppress-inactive
#         next-hop-self
#     neighbor 203.0.113.2
#       address-family ipv4 multicast
#         send-community
#

# Using deleted to remove all neighbor AFs

# Before state:
# -------------
# Nexus9000v# show running-config | section "^router bgp"
# router bgp 65536
#   neighbor 192.0.2.32
#     address-family ipv4 unicast
#       maximum-prefix 20 75
#       weight 100
#       prefix-list rmap1 in
#       prefix-list rmap2 out
#     address-family ipv6 unicast
#   neighbor 192.0.2.33
#     address-family ipv4 multicast
#       inherit peer-policy BasePolicy 200
#   vrf site-1
#     neighbor 203.0.113.1
#       address-family ipv4 unicast
#         suppress-inactive
#         next-hop-self
#     neighbor 203.0.113.2
#       address-family ipv4 multicast
#         send-community
#       address-family ipv6 unicast
#

- name: Delete all BGP neighbor AF configs handled by this module
  cisco.nxos.nxos_bgp_neighbor_address_family:
    state: deleted

# Task output:
# ------------
#  before:
#    as_number: "65536"
#    neighbors:
#      - neighbor_address: 192.0.2.32
#        address_family:
#          - afi: ipv4
#            safi: unicast
#            maximum_prefix:
#              max_prefix_limit: 20
#              generate_warning_threshold: 75
#            weight: 100
#            prefix_list:
#              inbound: rmap1
#              outbound: rmap2
#          - afi: ipv6
#            safi: unicast
#      - neighbor_address: 192.0.2.33
#        address_family:
#          - afi: ipv4
#            safi: multicast
#            inherit:
#              template: BasePolicy
#              sequence: 200
#    vrfs:
#      - vrf: site-1
#        neighbors:
#          - neighbor_address: 203.0.113.1
#            address_family:
#              - afi: ipv4
#                safi: unicast
#                suppress_inactive: true
#                next_hop_self:
#                  set: true
#          - neighbor_address: 203.0.113.2
#            address_family:
#              - afi: ipv4
#                safi: multicast
#                send_community:
#                  set: true
#              - afi: ipv6
#                safi: unicast
#
#  commands:
#    - router bgp 65536
#    - neighbor 192.0.2.32
#    - no address-family ipv4 unicast
#    - no address-family ipv6 unicast
#    - neighbor 192.0.2.33
#    - no address-family ipv4 multicast
#    - vrf site-1
#    - neighbor 203.0.113.1
#    - no address-family ipv4 unicast
#    - neighbor 203.0.113.2
#    - no address-family ipv6 unicast
#    - no address-family ipv4 multicast
#
#  after:
#    as_number: "65536"
#
# After state:
# ------------
# Nexus9000v# show running-config | section "^router bgp"
# router bgp 65536
#   neighbor 192.0.2.32
#   neighbor 192.0.2.33
#   vrf site-1
#     neighbor 203.0.113.1
#     neighbor 203.0.113.2
#

# Using rendered

- name: Render platform specific configuration lines with state rendered (without connecting to the device)
  cisco.nxos.nxos_bgp_neighbor_address_family:
    config:
      as_number: 65536
      neighbors:
        - neighbor_address: 192.0.2.32
          address_family:
            - afi: ipv4
              safi: unicast
              maximum_prefix:
                max_prefix_limit: 20
                generate_warning_threshold: 75
              weight: 100
              prefix_list:
                inbound: rmap1
                outbound: rmap2
            - afi: ipv6
              safi: unicast
        - neighbor_address: 192.0.2.33
          address_family:
            - afi: ipv4
              safi: multicast
              inherit:
                template: BasePolicy
                sequence: 200
      vrfs:
        - vrf: site-1
          neighbors:
            - neighbor_address: 203.0.113.1
              address_family:
                - afi: ipv4
                  safi: unicast
                  suppress_inactive: true
                  next_hop_self:
                    set: true
            - neighbor_address: 203.0.113.2
              address_family:
                - afi: ipv6
                  safi: unicast
                - afi: ipv4
                  safi: multicast
                  send_community:
                    set: true
    state: rendered

# Task output:
# ------------
#  rendered:
#    - router bgp 65536
#    - neighbor 192.0.2.32
#    - address-family ipv4 unicast
#    - maximum-prefix 20 75
#    - weight 100
#    - prefix-list rmap1 in
#    - prefix-list rmap2 out
#    - address-family ipv6 unicast
#    - neighbor 192.0.2.33
#    - address-family ipv4 multicast
#    - inherit peer-policy BasePolicy 200
#    - vrf site-1
#    - neighbor 203.0.113.1
#    - address-family ipv4 unicast
#    - suppress-inactive
#    - next-hop-self
#    - neighbor 203.0.113.2
#    - address-family ipv6 unicast
#    - address-family ipv4 multicast
#    - send-community

# Using parsed

# parsed.cfg
# ------------
# router bgp 65536
#   neighbor 192.0.2.32
#     address-family ipv4 unicast
#       maximum-prefix 20 75
#       weight 100
#       prefix-list rmap1 in
#       prefix-list rmap2 out
#     address-family ipv6 unicast
#   neighbor 192.0.2.33
#     address-family ipv4 multicast
#       inherit peer-policy BasePolicy 200
#   vrf site-1
#     neighbor 203.0.113.1
#       address-family ipv4 unicast
#         suppress-inactive
#         next-hop-self
#     neighbor 203.0.113.2
#       address-family ipv4 multicast
#         send-community
#       address-family ipv6 unicast

- name: Parse externally provided BGP neighbor AF config
  register: result
  cisco.nxos.nxos_bgp_neighbor_address_family:
    running_config: "{{ lookup('file', 'parsed.cfg') }}"
    state: parsed

# Task output:
# ------------
#  parsed:
#    as_number: "65536"
#    neighbors:
#      - neighbor_address: 192.0.2.32
#        address_family:
#          - afi: ipv4
#           safi: unicast
#           maximum_prefix:
#              max_prefix_limit: 20
#              generate_warning_threshold: 75
#           weight: 100
#            prefix_list:
#              inbound: rmap1
#              outbound: rmap2
#          - afi: ipv6
#            safi: unicast
#      - neighbor_address: 192.0.2.33
#        address_family:
#          - afi: ipv4
#            safi: multicast
#            inherit:
#              template: BasePolicy
#              sequence: 200
#    vrfs:
#      - vrf: site-1
#        neighbors:
#          - neighbor_address: 203.0.113.1
#            address_family:
#              - afi: ipv4
#                safi: unicast
#                suppress_inactive: true
#                next_hop_self:
#                  set: true
#          - neighbor_address: 203.0.113.2
#            address_family:
#              - afi: ipv4
#                safi: multicast
#                send_community:
#                  set: true
#              - afi: ipv6
#                safi: unicast

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

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

Ключ	Описание
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 192.0.2.32", "address-family ipv4 unicast"]`
gathered dictionary	Факты о сетевом ресурсе, собранные с удалённого устройства в виде структурированных данных. Возвращается: когда state имеет значение `gathered` Пример: `"This output will always be in the same format as the module argspec.\n"`
parsed dictionary	Встроенная конфигурация устройства, переданная в параметре 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 192.0.2.32", "address-family ipv4 unicast"]`

Авторы

Nilashish Chakraborty (@NilashishC)

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

© 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_neighbor_address_family_module.html