Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

Добавлено в cisco.ios 1.3.0

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

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

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

Примечание

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

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

Параметры

Параметр

Комментарии

config

dictionary

Словарь параметров конфигурации BGP.

aggregate_addresses

list / elements=dictionary

Настройка агрегированных записей BGP

address

string

Указание агрегированного адреса

advertise_map

string

Задание условия для анонсирования атрибута

as_confed_set

boolean

Формирование информации о пути AS confed set

Варианты:

  • false
  • true

as_set

boolean

Формирование информации о пути AS set

Варианты:

  • false
  • true

attribute_map

string

Задание атрибутов агрегированного маршрута

netmask

string

Указание маски агрегированного маршрута

summary_only

boolean

Фильтрация более специфичных маршрутов из обновлений

Варианты:

  • false
  • true

suppress_map

string

Условная фильтрация более специфичных маршрутов из обновлений

as_number

string

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

auto_summary

boolean

Включение автоматической агрегации сетевых адресов

Варианты:

  • false
  • true

bgp

dictionary

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

additional_paths

dictionary

Дополнительные пути в таблице BGP

install

boolean

Установка дополнительных путей в RIB

Варианты:

  • false
  • true

receive

boolean

Получение дополнительных путей от соседей

Варианты:

  • false
  • true

select

dictionary

Критерии выбора путей

all

boolean

Выбор всех доступных путей

Варианты:

  • false
  • true

best

integer

Выбор N лучших путей (2–3).

best_external

boolean

Выбор лучшего внешнего пути

Варианты:

  • false
  • true

group_best

boolean

Выбор лучшего пути группы

Варианты:

  • false
  • true

send

boolean

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

Варианты:

  • false
  • true

advertise_best_external

boolean

Анонсирование лучшего внешнего пути внутренним соседям

Варианты:

  • false
  • true

aggregate_timer

integer

Настройка таймера агрегации

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

always_compare_med

boolean

Разрешение сравнения MED от разных соседей

Варианты:

  • false
  • true

asnotation

boolean

Изменение используемой по умолчанию нотации AS на обычную

Нотация asdot

Варианты:

  • false
  • true

bestpath_options

dictionary

Изменение используемого по умолчанию выбора лучшего пути

aigp

boolean

Если в обоих путях отсутствует AIGP, игнорировать его при сравнении для выбора лучшего пути

игнорировать

Варианты:

  • false
  • true

compare_routerid

boolean

Сравнение идентификаторов маршрутизаторов для идентичных путей EBGP

Варианты:

  • false
  • true

cost_community

boolean

Сообщество стоимости

Варианты:

  • false
  • true

igp_metric

boolean

Метрика IGP

Игнорирование метрики IGP при выборе лучшего пути

Варианты:

  • false
  • true

med

dictionary

Атрибут MED

confed

boolean

Сравнение MED для путей конфедерации

Варианты:

  • false
  • true

missing_as_worst

boolean

Считать отсутствующий MED наименее предпочтительным

Варианты:

  • false
  • true

client_to_client

dictionary

Настройка отражения маршрутов между клиентами

all

boolean

межкластерное и внутрикластерное отражение (по умолчанию)

Варианты:

  • false
  • true

intra_cluster

string

Внутрикластерное отражение

Внутрикластерное отражение для cluster-id

set

boolean

Разрешение отражения маршрутов

Варианты:

  • false
  • true

cluster_id

string

Настройка cluster-id Route Reflector (соседи могут сбросить соединение)

A.B.C.D/Допустимые значения cluster-id Route Reflector см. в документации производителя

confederation

dictionary

Параметры конфедерации AS

identifier

string

Задание AS конфедерации домена маршрутизации

Номер AS

peers

string

Соседние AS в конфедерации BGP

Номер AS

consistency_checker

dictionary

Проверка согласованности

auto_repair

dictionary

Автоматическое исправление

interval

integer

Настройка проверки согласованности BGP

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

set

boolean

Включение автоматического исправления

Варианты:

  • false
  • true

error_message

dictionary

Запись сообщения об ошибке в журнал

interval

integer

Настройка проверки согласованности BGP

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

set

boolean

Включение сообщений об ошибках

Варианты:

  • false
  • true

dampening

dictionary

Включение подавления флаппинга маршрутов

max_suppress

integer

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

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

penalty_half_time

integer

Период полураспада штрафа

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

reuse_route_val

integer

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

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

route_map

string

Route-map для задания критериев подавления

suppress_route_val

integer

Пороговое значение для начала подавления маршрута

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

default

dictionary

Настройка параметров BGP по умолчанию

ipv4_unicast

boolean

Активация ipv4-unicast для соседа по умолчанию

Варианты:

  • false
  • true ← (по умолчанию)

route_target

dictionary

Управление поведением на основе атрибутов Route-Target

filter

boolean

Управление автоматической фильтрацией VPN Route-Target

Варианты:

  • false
  • true ← (по умолчанию)

deterministic_med

boolean

Выбор пути с наилучшим MED среди путей, анонсированных соседней AS

Варианты:

  • false
  • true

dmzlink_bw

boolean

Использование пропускной способности DMZ-канала в качестве веса для многопутевых маршрутов BGP

Варианты:

  • false
  • true

enforce_first_as

boolean

Требовать первый AS для маршрутов EBGP (по умолчанию)

Варианты:

  • false
  • true

enhanced_error

boolean

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

Варианты:

  • false
  • true

fast_external_fallover

boolean

Немедленно сбросить сеанс при отключении канала к непосредственно подключенному внешнему соседу

Варианты:

  • false
  • true

graceful_restart

dictionary

Параметры функции Graceful Restart

extended

boolean

Включить расширение Graceful Restart

Варианты:

  • false
  • true

restart_time

integer

Задать максимальное время, необходимое для перезапуска и восстановления работы

set

boolean

Включить Graceful Restart

Варианты:

  • false
  • true

stalepath_time

integer

Задать максимальное время хранения устаревших маршрутов перезапускающегося соседа

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

graceful_shutdown

dictionary

Параметры функции Graceful Shutdown

community

string

Задать community для маршрутов Gshut

Номер community/номер community в формате aa:nn

local_preference

integer

Задать Local Preference для маршрутов Gshut

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

neighbors

dictionary

Корректно завершить работу всех соседей

activate

boolean

Активировать корректное завершение работы всех соседей

Варианты:

  • false
  • true

time

integer

Время в секундах

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

vrfs

dictionary

Корректно завершить работу всех соседей VRF

activate

boolean

Активировать корректное завершение работы всех соседей

Варианты:

  • false
  • true

time

integer

Время в секундах

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

inject_maps

list / elements=dictionary

Route-map, задающая внедряемые префиксы

copy_attributes

boolean

Копировать атрибуты из агрегата

Варианты:

  • false
  • true

exist_map_name

string

Имя route-map

name

string

Имя route-map

listen

dictionary

Прослушивание диапазона подсетей соседей

limit

integer

Задать максимальное количество соседей для динамического диапазона подсетей

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

range

dictionary

Диапазон сетей подсетей

host_with_subnet

string

Диапазон подсетей IPv4 (A.B.C.D/nn)

Диапазон подсетей IPv6 (X:X:X:X::X/<0-128>)

peer_group

string

Участник группы соседей

log_neighbor_changes

boolean

Вести журнал событий подключения/отключения соседа и причин сброса

Варианты:

  • false
  • true

maxas_limit

integer

Разрешить атрибут AS-PATH от любого соседа, ограничив количество AS

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

maxcommunity_limit

integer

Разрешить атрибут COMMUNITY от любого соседа, ограничив количество community

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

maxextcommunity_limit

integer

Разрешить атрибут EXTENDED COMMUNITY от любого соседа, ограничив количество расширенных community

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

nexthop

dictionary

Команды отслеживания следующего перехода

route_map

string

Route-map для допустимых следующих переходов

trigger

dictionary

Отслеживание следующих переходов

delay

integer

Задать задержку перед запуском отслеживания следующего перехода

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

enable

boolean

Включить отслеживание следующего перехода

Варианты:

  • false
  • true

nopeerup_delay_options

dictionary

Задать время ожидания первого подключения соседа BGP перед запуском таймеров задержки обновления или Graceful Restart (в секундах)

cold_boot

integer

Время ожидания первого подключения соседа после холодной загрузки

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

nsf_switchover

integer

Время ожидания первого соседа после переключения NSF

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

post_boot

integer

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

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

user_initiated

integer

Время ожидания первого соседа после ручного сброса соседей BGP пользователем-администратором

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

recursion

boolean

Правило рекурсии для следующих переходов

Рекурсия через хост для следующих переходов

Варианты:

  • false
  • true

redistribute_internal

boolean

Разрешить перераспределение iBGP в IGP (опасно)

Варианты:

  • false
  • true

refresh

dictionary

Обновление

max_eor_time

integer

Настроить максимальное время EOR при обновлении

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

stalepath_time

integer

Настроить время хранения устаревших маршрутов при обновлении

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

regexp

boolean

Выбрать механизм регулярных выражений

Включить механизм регулярных выражений с ограниченным временем выполнения

Варианты:

  • false
  • true

route_map

boolean

Команды управления route-map

Установить приоритет команд set в route-map над командами BGP, например next-hop unchanged

Варианты:

  • false
  • true

router_id

dictionary

Переопределить настроенный идентификатор маршрутизатора (соседи будут сброшены)

address

string

Идентификатор маршрутизатора, заданный вручную (A.B.C.D)

interface

string

Использовать IPv4-адрес интерфейса

vrf

boolean

Настройка идентификатора маршрутизатора для конкретной VRF

Автоматически назначать идентификатор маршрутизатора BGP для каждой VRF

Варианты:

  • false
  • true

scan_time

integer

Настроить интервал фонового сканирования

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

slow_peer

dictionary

Настроить медленного соседа

detection

dictionary

Обнаружение медленного соседа

set

boolean

Обнаружение медленного соседа

Варианты:

  • false
  • true

threshold

integer

Задать порог обнаружения медленного соседа

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

split_update_group

dictionary

Настроить разделение группы обновлений медленных соседей

dynamic

boolean

Динамически перемещать медленного соседа в группу медленных обновлений

Варианты:

  • false
  • true

permanent

boolean

Постоянно оставлять медленного соседа в группе медленных обновлений

Варианты:

  • false
  • true

snmp

boolean

Параметры SNMP для BGP

Параметры SNMP-ловушек BGP

Использовать cbgp Peer2Type как часть индекса ловушек

Варианты:

  • false
  • true

soft_reconfig_backup

boolean

Использовать входящую soft-reconfiguration, только если route-refresh не согласован

Варианты:

  • false
  • true

sso

boolean

Переключение с сохранением состояния

Включить SSO только для соседей, поддерживающих Route-Refresh

Варианты:

  • false
  • true

suppress_inactive

boolean

Подавлять маршруты, отсутствующие в таблице маршрутизации

Варианты:

  • false
  • true

transport

boolean

Глобальное включение/отключение параметров транспортной сессии

Обнаружение MTU пути транспорта

Варианты:

  • false
  • true

update_delay

integer

Задать максимальную начальную задержку перед отправкой обновления

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

update_group

boolean

Управлять соседями в группах обновления BGP

Разделять группы обновления на основе политик

Размещать соседей с as-override в разных группах обновления

Варианты:

  • false
  • true

upgrade_cli

dictionary

Обновить до иерархического режима AFI

af_mode

boolean

Обновить до режима AFI

Варианты:

  • false
  • true

set

boolean

включить обновление до иерархического режима AFI

Варианты:

  • false
  • true

bmp

dictionary

Протокол мониторинга BGP

buffer_size

integer

Размер буфера BMP

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

initial_refresh

dictionary

Параметры начального обновления

delay

integer

Задержка перед начальным обновлением

skip

boolean

пропустить все обновления

Варианты:

  • false
  • true

server

integer

Сведения о сервере

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

server_options

dictionary

параметры сервера BMP

activate

boolean

активировать сервер

Варианты:

  • false
  • true

address

dictionary

пропустить все обновления

host

string

адрес узла

port

integer

номер порта сервера BMP

default_information

boolean

Управлять распространением информации по умолчанию

Распространять маршрут по умолчанию

Варианты:

  • false
  • true

default_metric

integer

Задать метрику перераспределяемых маршрутов

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

distance

dictionary

Задать административное расстояние

admin

dictionary

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

acl

string

Номер стандартного списка доступа IP

Номер расширенного стандартного списка доступа IP

Имя стандартного списка доступа

address

string

IP-адрес источника (A.B.C.D)

distance

integer

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

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

wildcard_bit

string

Биты маски подстановки (A.B.C.D)

bgp

dictionary

Расстояние BGP

routes_external

integer

Расстояние для маршрутов, внешних по отношению к AS

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

routes_internal

integer

Расстояние для маршрутов внутри AS

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

routes_local

integer

Расстояние для локальных маршрутов

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

mbgp

dictionary

Расстояние MBGP

routes_external

integer

Расстояние для маршрутов, внешних по отношению к AS

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

routes_internal

integer

Расстояние для маршрутов внутри AS

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

routes_local

integer

Расстояние для локальных маршрутов

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

distributes

list / elements=dictionary

Фильтровать сети в обновлениях маршрутизации

acl

string

Номер/имя списка доступа IP

gateway

string

Фильтровать префиксы в обновлениях маршрутизации

in

boolean

Фильтровать входящие обновления маршрутизации

Варианты:

  • false
  • true

interface

string

сведения об интерфейсе

out

boolean

Фильтровать исходящие обновления маршрутизации

Варианты:

  • false
  • true

prefix

string

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

maximum_paths

dictionary

Пересылать пакеты по нескольким путям

eibgp

integer

Использовать пути eBGP и iBGP для многопутевой маршрутизации

ibgp

integer

Многопутевая маршрутизация iBGP

paths

integer

Количество путей

maximum_secondary_paths

dictionary

Максимальное количество вторичных путей

eibgp

integer

Использовать пути eBGP и iBGP для вторичной многопутевой маршрутизации

ibgp

integer

Вторичная многопутевая маршрутизация iBGP

paths

integer

Количество вторичных путей

neighbors

псевдонимы: neighbor

list / elements=dictionary

Указать соседний маршрутизатор

activate

boolean

Включить семейство адресов для этого соседа

Варианты:

  • false
  • true

additional_paths

dictionary

Согласовать с этим соседом возможности дополнительных путей

disable

boolean

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

Варианты:

  • false
  • true

receive

boolean

Получать дополнительные пути от соседей

Варианты:

  • false
  • true

send

boolean

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

Варианты:

  • false
  • true

advertise

dictionary

Анонсировать этому соседу

additional_paths

dictionary

Анонсировать дополнительные пути

all

boolean

Выбрать все доступные пути

Варианты:

  • false
  • true

best

integer

Выбрать N лучших путей (2–3).

group_best

boolean

Выбрать лучший путь группы

Варианты:

  • false
  • true

best_external

boolean

Анонсировать лучший внешний путь (на RR — лучший внутренний путь)

Варианты:

  • false
  • true

diverse_path

dictionary

Анонсировать дополнительные пути

backup

boolean

Различный путь может быть резервным

Варианты:

  • false
  • true

mpath

boolean

Разнообразный путь может быть многопутевым

Варианты:

  • false
  • true

advertise_map

dictionary

Задать route-map для условного анонсирования

exist_map

string

Анонсировать префикс, только если он присутствует в условии

Имя route-map условия

name

string

Имя route-map для анонсирования

non_exist_map

string

Анонсировать префикс, только если он отсутствует в условии

Имя route-map условия

advertisement_interval

integer

Минимальный интервал между отправкой обновлений маршрутизации BGP

aigp

dictionary

AIGP для соседа

enable

boolean

Включить AIGP

Варианты:

  • false
  • true

send

dictionary

Сообщество стоимости или MED, передающее значение AIGP

cost_community

dictionary

Расширенное сообщество стоимости, передающее значение AIGP

id

integer

Идентификатор сообщества

Допустимые значения см. в документации поставщика

poi

dictionary

Точка вставки

igp_cost

boolean

Точка вставки после IGP

Варианты:

  • false
  • true

pre_bestpath

boolean

Точка вставки в начале

Варианты:

  • false
  • true

transitive

boolean

Сообщество стоимости является транзитивным

Варианты:

  • false
  • true

med

boolean

MED, передающий значение AIGP

Варианты:

  • false
  • true

allow_policy

boolean

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

Варианты:

  • false
  • true

allowas_in

integer

Принимать AS-путь, содержащий мою AS

as_override

boolean

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

Сохранять Split Horizon при отправке обновления

Варианты:

  • false
  • true

bmp_activate

dictionary

Включить мониторинг BMP для узла BGP

all

boolean

Включить мониторинг BMP для всех серверов

Варианты:

  • false
  • true

server

integer

Включить BMP для сервера

Номер сервера BMP

Допустимые значения см. в документации поставщика

capability

dictionary

Анонсировать возможности соседу

Анонсировать возможность ORF соседу

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

both

boolean

Возможность ОТПРАВЛЯТЬ ORF этому соседу и ПОЛУЧАТЬ ORF от него

Варианты:

  • false
  • true

receive

boolean

Возможность ПОЛУЧАТЬ ORF от этого соседа

Варианты:

  • false
  • true

send

boolean

Возможность ОТПРАВЛЯТЬ ORF этому соседу

Варианты:

  • false
  • true

cluster_id

string

Настроить идентификатор кластера Route-Reflector (соседи могут быть сброшены)

Идентификатор кластера Route-Reflector в виде 32-битного значения или в формате IP-адреса (A.B.C.D)

default_originate

dictionary

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

route_map

string

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

set

boolean

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

Варианты:

  • false
  • true

description

string

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

disable_connected_check

boolean

Однохоповый сосед EBGP, использующий адрес loopback

Варианты:

  • false
  • true

distribute_list

dictionary

Фильтровать обновления от этого соседа и к нему

acl

string

Номер или имя списка контроля доступа IP

in

boolean

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

Варианты:

  • false
  • true

out

boolean

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

Варианты:

  • false
  • true

dmzlink_bw

boolean

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

Варианты:

  • false
  • true

ebgp_multihop

dictionary

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

enable

boolean

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

Варианты:

  • false
  • true

hop_count

integer

Максимальное количество переходов

Допустимые значения см. в документации поставщика

fall_over

dictionary

Завершать сеанс при потере маршрута соседа

bfd

dictionary

Использовать BFD для обнаружения сбоя

multi_hop

boolean

Принудительно использовать многохоповый BFD для обнаружения сбоя

Варианты:

  • false
  • true

set

boolean

Включить BFD

Варианты:

  • false
  • true

single_hop

boolean

Принудительно использовать однохоповый BFD для обнаружения сбоя

Варианты:

  • false
  • true

route_map

string

Route-map для маршрута соседа

filter_list

dictionary

Настроить фильтры BGP

in

boolean

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

Варианты:

  • false
  • true

out

boolean

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

Варианты:

  • false
  • true

path_acl

string

Список контроля доступа к AS-пути

ha_mode

dictionary

Режим высокой доступности

disable

boolean

Отключить graceful-restart

Варианты:

  • false
  • true

set

boolean

Задать ha-mode и graceful-restart для этого узла

Варианты:

  • false
  • true

inherit

string

Наследовать шаблон

Наследовать шаблон сеанса узла; имя шаблона

local_as

dictionary

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

dual_as

boolean

Принимать от узла eBGP как реальную AS, так и локальную AS

Варианты:

  • false
  • true

no_prepend

dictionary

Не добавлять local-as в начало обновлений от узлов eBGP

replace_as

boolean

Заменять реальную AS локальной AS в обновлениях EBGP

Варианты:

  • false
  • true

set

boolean

Задать добавление в начало

Варианты:

  • false
  • true

number

integer

Номер AS, используемый в качестве локальной AS

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

set

boolean

Задать номер local-as

Варианты:

  • false
  • true

log_neighbor_changes

dictionary

Записывать в журнал события подключения/отключения узла и причину сброса

disable

boolean

Отключить ведение журнала событий подключения/отключения узла и сброса

Варианты:

  • false
  • true

set

boolean

Вести журнал событий подключения/отключения узла и сброса

Варианты:

  • false
  • true

maximum_prefix

dictionary

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

max_no

integer

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

restart

integer

Перезапустить соединение BGP после превышения лимита

threshold_val

integer

Пороговое значение (%), при достижении которого выводится предупреждение

warning_only

boolean

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

Варианты:

  • false
  • true

neighbor_address

string

Адрес узла (A.B.C.D)

Идентификатор узла

IPv6-адрес узла (X:X:X:X::X)

next_hop_self

dictionary

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

all

boolean

Включить next-hop-self для полученных маршрутов eBGP и iBGP

Варианты:

  • false
  • true

set

boolean

Включить next-hop-self

Варианты:

  • false
  • true

next_hop_unchanged

dictionary

Передавать следующий переход без изменений для маршрутов iBGP этому узлу

Передавать следующий переход без изменений для всех маршрутов (iBGP и eBGP) этому узлу

allpaths

boolean

Передавать следующий переход без изменений для всех маршрутов (iBGP и eBGP) этому узлу

Варианты:

  • false
  • true

set

boolean

Включить next-hop-unchanged

Варианты:

  • false
  • true

password_options

dictionary

Задать пароль и тип шифрования

encryption

integer

Тип шифрования (0 — отключить шифрование, 7 — проприетарный тип)

pass_key

string

Пароль

path_attribute

dictionary

Фильтрация необязательных атрибутов BGP

discard

dictionary

Отбрасывать совпадающий атрибут маршрута для этого узла

in

boolean

Выполнять фильтрацию входящих атрибутов маршрута

Варианты:

  • false
  • true

range

dictionary

Диапазон атрибутов маршрута

end

integer

Конечное значение диапазона атрибутов маршрута

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

start

integer

Начальное значение диапазона атрибутов маршрута

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

type

integer

Тип атрибута маршрута

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

treat_as_withdraw

dictionary

Считать совпадающий атрибут маршрута для этого узла отозванным

in

boolean

Выполнять фильтрацию входящих атрибутов маршрута

Варианты:

  • false
  • true

range

dictionary

Диапазон атрибутов маршрута

end

integer

Конечное значение диапазона атрибутов маршрута

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

start

integer

Начальное значение диапазона атрибутов маршрута

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

type

integer

Тип атрибута маршрута

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

peer_group

string

Участник группы узлов

remote_as

string

Указать соседний узел BGP

AS удаленного узла

remove_private_as

dictionary

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

all

boolean

Удалять все номера частных AS

Варианты:

  • false
  • true

replace_as

boolean

Заменять все номера частных AS локальной AS

Варианты:

  • false
  • true

set

boolean

Удалять номер частной AS

Варианты:

  • false
  • true

route_maps

list / elements=dictionary

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

in

boolean

Применить карту к входящим маршрутам

Варианты:

  • false
  • true

name

string

Заменять все номера частных AS локальной AS

out

boolean

Применить карту к исходящим маршрутам

Варианты:

  • false
  • true

route_reflector_client

boolean

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

Варианты:

  • false
  • true

route_server_client

dictionary

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

context

string

Указать контекст Route Server для соседа

Имя контекста Route Server

set

boolean

Назначить клиента Route Server

Варианты:

  • false
  • true

send_community

dictionary

Передавать атрибут Community этому соседу

both

boolean

Передавать атрибуты Standard и Extended Community

Варианты:

  • false
  • true

extended

boolean

Передавать атрибут Extended Community

Варианты:

  • false
  • true

set

boolean

Включить передачу атрибута Community этому соседу

Варианты:

  • false
  • true

standard

boolean

Передавать атрибут Standard Community

Варианты:

  • false
  • true

send_label

dictionary

Передавать NLRI и метку MPLS этому соседу

explicit_null

boolean

Анонсировать метку Explicit Null вместо Implicit Null

Варианты:

  • false
  • true

set

boolean

Включить передачу NLRI и метки MPLS этому соседу

Варианты:

  • false
  • true

shutdown

dictionary

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

community

integer

Задать Community для маршрутов Gshut

graceful

integer

Корректно отключить этого соседа

Время в секундах

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

local_preference

boolean

Задать Local Preference для маршрутов Gshut

Варианты:

  • false
  • true

set

boolean

Отключить

Варианты:

  • false
  • true

slow_peer

dictionary

Настроить slow-peer

detection

dictionary

Настроить slow-peer

disable

boolean

Отключить обнаружение slow-peer

Варианты:

  • false
  • true

enable

boolean

Включить обнаружение slow-peer

Варианты:

  • false
  • true

threshold

integer

Задать порог обнаружения slow-peer

split_update_group

dictionary

Настроить разделение slow-peer на группы обновлений

dynamic

dictionary

Динамически выделить slow-peer в отдельную группу обновлений

disable

boolean

Отключить обнаружение slow-peer

Варианты:

  • false
  • true

enable

boolean

Включить обнаружение slow-peer

Варианты:

  • false
  • true

permanent

boolean

Постоянно оставлять slow-peer в группе медленных обновлений

Варианты:

  • false
  • true

static

boolean

Статический slow-peer

Варианты:

  • false
  • true

soft_reconfiguration

boolean

Мягкая реконфигурация для каждого соседа

Разрешить входящую мягкую реконфигурацию для этого соседа

Варианты:

  • false
  • true

timers

dictionary

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

holdtime

integer

Время удержания соединения

interval

integer

Интервал отправки keepalive

min_holdtime

integer

Минимальное время удержания, установленное соседом

translate_update

dictionary

Преобразовать Update в формат MBGP

nlri

dictionary

Указать тип NLRI для преобразования

multicast

boolean

Преобразовать Update в многоадресный NLRI

Варианты:

  • false
  • true

unicast

boolean

Обрабатывать Update как одноадресный NLRI

Варианты:

  • false
  • true

set

boolean

Включить преобразование Update

Варианты:

  • false
  • true

transport

dictionary

Параметры транспорта

connection_mode

dictionary

Указать пассивное или активное подключение

active

boolean

Активно устанавливать сеанс TCP

Варианты:

  • false
  • true

passive

boolean

Пассивно устанавливать сеанс TCP

Варианты:

  • false
  • true

multi_session

boolean

Использовать мультисеансовый режим для транспорта

Варианты:

  • false
  • true

path_mtu_discovery

dictionary

Использовать обнаружение MTU пути для транспорта

disable

boolean

Отключить

Варианты:

  • false
  • true

set

boolean

Использовать обнаружение MTU пути

Варианты:

  • false
  • true

ttl_security

integer

Проверка безопасности TTL в BGP

Максимальное количество переходов

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

unsuppress_map

string

Route map для выборочного снятия подавления с подавленных маршрутов

Имя route map

update_source

string

Источник обновлений маршрутизации

version

integer

Задать версию BGP для соответствия версии соседа

Версия BGP соседа

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

weight

integer

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

networks

list / elements=dictionary

Указать сеть для анонсирования через BGP

address

string

Указать сетевой адрес

backdoor

boolean

Указать резервный маршрут BGP

Варианты:

  • false
  • true

netmask

string

Указать маску сети

route_map

string

Route map для изменения атрибутов

redistribute

list / elements=dictionary

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

application

dictionary

Приложение

metric

integer

Метрика перераспределяемых маршрутов

name

string

Имя приложения

route_map

string

Ссылка на route map

bgp

dictionary

Протокол граничного шлюза (BGP)

as_number

string

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

metric

integer

Метрика перераспределяемых маршрутов

route_map

string

Ссылка на route map

connected

dictionary

Подключенные сети

metric

integer

Метрика перераспределяемых маршрутов

route_map

string

Ссылка на route map

set

boolean

Задать атрибут верхнего уровня

Варианты:

  • false
  • true

eigrp

dictionary

Усовершенствованный протокол маршрутизации внутреннего шлюза (EIGRP)

as_number

string

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

metric

integer

Метрика перераспределяемых маршрутов

route_map

string

Ссылка на route map

isis

dictionary

ISO IS-IS

area_tag

string

Метка области маршрутизации ISO

clns

boolean

Перераспределение динамических маршрутов OSI

Варианты:

  • false
  • true

ip

boolean

Перераспределение динамических IP-маршрутов

Варианты:

  • false
  • true

metric

integer

Метрика перераспределяемых маршрутов

route_map

string

Ссылка на route map

iso_igrp

dictionary

IGRP для сетей OSI

area_tag

string

Метка области маршрутизации ISO

route_map

string

Ссылка на route map

lisp

dictionary

Протокол разделения идентификаторов и локаторов (LISP)

metric

integer

Метрика перераспределяемых маршрутов

route_map

string

Ссылка на route map

set

boolean

Задать атрибут верхнего уровня

Варианты:

  • false
  • true

mobile

dictionary

Мобильные маршруты

metric

integer

Метрика перераспределяемых маршрутов

route_map

string

Ссылка на route map

set

boolean

Задать атрибут верхнего уровня

Варианты:

  • false
  • true

odr

dictionary

Маршруты заглушек по запросу

metric

integer

Метрика перераспределяемых маршрутов

route_map

string

Ссылка на route map

set

boolean

Задать атрибут верхнего уровня

Варианты:

  • false
  • true

ospf

dictionary

Протокол OSPF (Open Shortest Path First)

match

dictionary

Маршруты заглушек по запросу

external

boolean

Перераспределять внешние маршруты OSPF

Варианты:

  • false
  • true

internal

boolean

Перераспределять внутренние маршруты OSPF

Варианты:

  • false
  • true

nssa_external

boolean

Перераспределять внешние маршруты OSPF NSSA

Варианты:

  • false
  • true

type_1

boolean

Перераспределять внешние маршруты NSSA типа 1

Варианты:

  • false
  • true

type_2

boolean

Перераспределять внешние маршруты NSSA типа 2

Варианты:

  • false
  • true

metric

integer

Метрика перераспределяемых маршрутов

process_id

integer

Идентификатор процесса

route_map

string

Ссылка на route map

vrf

string

Экземпляр маршрутизации/пересылки VPN

ospfv3

dictionary

OSPFv3

match

dictionary

Маршруты заглушек по запросу

external

boolean

Перераспределять внешние маршруты OSPF

Варианты:

  • false
  • true

internal

boolean

Перераспределять внутренние маршруты OSPF

Варианты:

  • false
  • true

nssa_external

boolean

Перераспределять внешние маршруты OSPF NSSA

Варианты:

  • false
  • true

type_1

boolean

Перераспределять внешние маршруты NSSA типа 1

Варианты:

  • false
  • true

type_2

boolean

Перераспределять внешние маршруты NSSA типа 2

Варианты:

  • false
  • true

metric

integer

Метрика перераспределяемых маршрутов

process_id

integer

Идентификатор процесса

route_map

string

Ссылка на route map

rip

dictionary

Протокол маршрутной информации (RIP)

metric

integer

Метрика перераспределяемых маршрутов

route_map

string

Ссылка на route map

set

boolean

Задать атрибут верхнего уровня

Варианты:

  • false
  • true

static

dictionary

Статические маршруты

clns

boolean

Перераспределение статических маршрутов OSI

Варианты:

  • false
  • true

ip

boolean

Перераспределение статических IP-маршрутов

Варианты:

  • false
  • true

metric

integer

Метрика перераспределяемых маршрутов

route_map

string

Ссылка на карту маршрутизации

set

boolean

Задать атрибут верхнего уровня

Варианты:

  • false
  • true

vrf

dictionary

Указать исходную VRF

global

boolean

Глобальная VRF

Варианты:

  • false
  • true

name

string

Имя исходной VRF

synchronization

boolean

Выполнять синхронизацию IGP

Варианты:

  • false
  • true

table_map

dictionary

Сопоставлять атрибуты внешних записей с таблицей маршрутизации

filter

boolean

Выборочная загрузка маршрутов

Варианты:

  • false
  • true

name

string

Имя route-map

template

dictionary

Перейти в режим команды шаблона

peer_policy

string

Конфигурация шаблона для параметров политики

peer_session

string

Конфигурация шаблона для параметров сеанса

timers

dictionary

Настройка таймеров маршрутизации

Таймеры BGP

holdtime

integer

Время удержания

keepalive

integer

Интервал keepalive

min_holdtime

integer

Минимальное время удержания, заданное соседом

running_config

string

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

Значением этого параметра должен быть вывод, полученный с устройства IOS при выполнении команды sh running-config | section ^router bgp.

Состояние parsed считывает конфигурацию из параметра running_config и преобразует её в структурированные данные Ansible в соответствии со спецификацией аргументов модуля ресурса, после чего значение возвращается в ключе parsed в результате.

state

string

Состояние, в котором должна остаться конфигурация

Модуль ведёт себя декларативно и одинаково для состояний replaced и overridden.

Состояния rendered, gathered и parsed не вносят изменений на устройстве.

Состояние rendered преобразует конфигурацию в параметре config в платформо-зависимые команды CLI, которые возвращаются в ключе rendered в результате. Для состояния rendered активное подключение к удалённому узлу не требуется.

Состояние gathered получает текущую конфигурацию устройства и преобразует её в структурированные данные в формате, соответствующем спецификации аргументов модуля ресурса; значение возвращается в ключе gathered в результате.

Состояние parsed считывает конфигурацию из параметра running_config и преобразует её в формат JSON в соответствии с параметрами модуля; значение возвращается в ключе parsed в результате. Значение параметра running_config должно иметь тот же формат, что и вывод команды show running-config | section ^router bgp, выполненной на устройстве. Для состояния parsed активное подключение к удалённому узлу не требуется.

Варианты:

  • "merged" ← (по умолчанию)
  • "replaced"
  • "overridden"
  • "deleted"
  • "purged"
  • "gathered"
  • "rendered"
  • "parsed"

Примечания

Примечание

  • Проверено на Cisco IOS-XE версии 17.3 в CML.
  • Этот модуль работает с подключением network_cli. См. https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html
  • В примерах модуля используется плагин обратного вызова (stdout_callback = yaml) для вывода задач в формате yaml.

Примеры

# Using merged

# Before state:
# -------------
#
# vios#sh running-config | section ^router bgp

- name: Merge provided configuration with device configuration
  cisco.ios.ios_bgp_global:
    config:
      as_number: 65000
      bgp:
        advertise_best_external: true
        bestpath_options:
          compare_routerid: true
        dampening:
          penalty_half_time: 1
          reuse_route_val: 1
          suppress_route_val: 1
          max_suppress: 1
        default:
          ipv4_unicast: false
          route_target:
            filter: true
        graceful_shutdown:
          neighbors:
            time: 50
          community: 100
          local_preference: 100
        log_neighbor_changes: true
        nopeerup_delay_options:
          post_boot: 10
      networks:
        - address: 192.0.2.3
        - address: 192.0.2.2
      neighbors:
        - neighbor_address: 192.0.2.1
          description: merge neighbor
          remote_as: 100
          aigp:
            send:
              cost_community:
                id: 100
                poi:
                  igp_cost: true
                  transitive: true
          route_maps:
            - name: test-route
              out: true
      redistribute:
        - connected:
            metric: 10
      timers:
        keepalive: 100
        holdtime: 200
        min_holdtime: 150
    state: merged

# Task Output:
# ------------
#
# before: {}
# commands:
# - router bgp 65000
# - timers bgp 100 200 150
# - bgp advertise-best-external
# - bgp bestpath compare-routerid
# - no bgp default ipv4-unicast
# - bgp dampening 1 1 1 1
# - bgp graceful-shutdown all neighbors 50 local-preference 100 community 100
# - bgp log-neighbor-changes
# - bgp nopeerup-delay post-boot 10
# - network 192.0.2.3
# - network 192.0.2.2
# - neighbor 192.0.2.1 remote-as 100
# - neighbor 192.0.2.1 description merge neighbor
# - neighbor 192.0.2.1 aigp send cost-community 100 poi igp-cost transitive
# - neighbor 192.0.2.1 route-map test-route out
# - redistribute connected metric 10
# after:
#   as_number: '65000'
#   bgp:
#     advertise_best_external: true
#     bestpath_options:
#       compare_routerid: true
#     dampening:
#       max_suppress: 1
#       penalty_half_time: 1
#       reuse_route_val: 1
#       suppress_route_val: 1
#     default:
#       ipv4_unicast: false
#       route_target:
#         filter: true
#     graceful_shutdown:
#       community: '100'
#       local_preference: 100
#       neighbors:
#         time: 50
#     log_neighbor_changes: true
#     nopeerup_delay_options:
#       post_boot: 10
#   neighbors:
#   - aigp:
#       send:
#         cost_community:
#           id: 100
#           poi:
#             igp_cost: true
#             transitive: true
#     description: merge neighbor
#     neighbor_address: 192.0.2.1
#     remote_as: '100'
#     route_maps:
#     - name: test-route
#       out: true
#   networks:
#   - address: 192.0.2.2
#   - address: 192.0.2.3
#   redistribute:
#   - connected:
#       metric: 10
#       set: true
#   timers:
#     holdtime: 200
#     keepalive: 100
#     min_holdtime: 150

# After state:
# ------------
#
# vios#sh running-config | section ^router bgp
# router bgp 65000
#  no bgp default ipv4-unicast
#  bgp log-neighbor-changes
#  bgp nopeerup-delay post-boot 10
#  bgp graceful-shutdown all neighbors 50 local-preference 100 community 100
#  bgp bestpath compare-routerid
#  bgp dampening 1 1 1 1
#  bgp advertise-best-external
#  network 192.0.2.2
#  network 192.0.2.3
#  timers bgp 100 200 150
#  redistribute connected metric 10
#  neighbor 192.0.2.1 remote-as 100
#  neighbor 192.0.2.1 description merge neighbor
#  neighbor 192.0.2.1 aigp send cost-community 100 poi igp-cost transitive
#  neighbor 192.0.2.1 route-map test-route out

# Using replaced

# Before state:
# -------------
#
# vios#sh running-config | section ^router bgp
# router bgp 65000
#  bgp nopeerup-delay post-boot 10
#  bgp graceful-shutdown all neighbors 50 local-preference 100 community 100
#  bgp bestpath compare-routerid
#  bgp dampening 1 1 1 1
#  network 192.0.2.2
#  network 192.0.2.3
#  bgp advertise-best-external
#  neighbor 198.0.2.1 remote-as 100
#  neighbor 198.0.2.1 description merge neighbor
#  neighbor 198.0.2.1 aigp send cost-community 100 poi igp-cost transitive
#  neighbor 198.0.2.1 route-map test-route out

- name: Replaces device configuration of listed global BGP with provided configuration
  cisco.ios.ios_bgp_global:
    config:
      as_number: 65000
      bgp:
        advertise_best_external: true
        bestpath_options:
          med:
            confed: true
        log_neighbor_changes: true
        nopeerup_delay_options:
          post_boot: 10
          cold_boot: 20
      networks:
        - address: 192.0.2.4
      neighbors:
        - neighbor_address: 192.0.2.5
          description: replace neighbor
          remote_as: 100
          slow_peer:
            detection:
              disable: true
    state: replaced

# Task Output:
# ------------
#
# before:
#   as_number: '65000'
#   bgp:
#     advertise_best_external: true
#     bestpath_options:
#       compare_routerid: true
#     dampening:
#       max_suppress: 1
#       penalty_half_time: 1
#       reuse_route_val: 1
#       suppress_route_val: 1
#     default:
#       ipv4_unicast: true
#       route_target:
#         filter: true
#     graceful_shutdown:
#       community: '100'
#       local_preference: 100
#       neighbors:
#         time: 50
#     log_neighbor_changes: true
#     nopeerup_delay_options:
#       post_boot: 10
#   neighbors:
#   - aigp:
#       send:
#         cost_community:
#           id: 100
#           poi:
#             igp_cost: true
#             transitive: true
#     description: merge neighbor
#     neighbor_address: 198.0.2.1
#     remote_as: '100'
#     route_maps:
#     - name: test-route
#       out: true
#   networks:
#   - address: 192.0.2.2
#   - address: 192.0.2.3
#
# commands:
# - router bgp 65000
# - no bgp bestpath compare-routerid
# - bgp bestpath med confed
# - no bgp dampening 1 1 1 1
# - no bgp graceful-shutdown all neighbors 50 local-preference 100 community 100
# - bgp nopeerup-delay cold-boot 20
# - network 192.0.2.4
# - no network 192.0.2.2
# - no network 192.0.2.3
# - neighbor 192.0.2.5 remote-as 100
# - neighbor 192.0.2.5 description replace neighbor
# - neighbor 192.0.2.5 slow-peer detection disable
# - no neighbor 198.0.2.1
# after:
#   as_number: '65000'
#   bgp:
#     advertise_best_external: true
#     bestpath_options:
#       med:
#         confed: true
#     default:
#       ipv4_unicast: true
#       route_target:
#         filter: true
#     log_neighbor_changes: true
#     nopeerup_delay_options:
#       cold_boot: 20
#       post_boot: 10
#   neighbors:
#   - description: replace neighbor
#     neighbor_address: 192.0.2.5
#     remote_as: '100'
#     slow_peer:
#       detection:
#         disable: true
#   networks:
#   - address: 192.0.2.4

# After state:
# -------------
#
# vios#sh running-config | section ^router bgp
# router bgp 65000
#  bgp log-neighbor-changes
#  bgp nopeerup-delay cold-boot 20
#  bgp nopeerup-delay post-boot 10
#  bgp bestpath med confed
#  bgp advertise-best-external
#  network 192.0.2.4
#  neighbor 192.0.2.5 remote-as 100
#  neighbor 192.0.2.5 description replace neighbor
#  neighbor 192.0.2.5 slow-peer detection disable

# Using Deleted

# Before state:
# -------------
#
# vios#sh running-config | section ^router bgp
# router bgp 65000
#  bgp nopeerup-delay post-boot 10
#  bgp graceful-shutdown all neighbors 50 local-preference 100 community 100
#  bgp bestpath compare-routerid
#  bgp dampening 1 1 1 1
#  bgp advertise-best-external
#  neighbor 192.0.2.1 remote-as 100
#  neighbor 192.0.2.1 description merge neighbor
#  neighbor 192.0.2.1 aigp send cost-community 100 poi igp-cost transitive
#  neighbor 192.0.2.1 route-map test-route out

- name: "Delete global BGP (Note: This won't delete the configured global BGP)"
  cisco.ios.ios_bgp_global:
    config:
      as_number: 65000
    state: deleted

# Task Output:
# ------------
#
# before:
#   as_number: '65000'
#   bgp:
#     advertise_best_external: true
#     bestpath_options:
#       compare_routerid: true
#     dampening:
#       max_suppress: 1
#       penalty_half_time: 1
#       reuse_route_val: 1
#       suppress_route_val: 1
#     default:
#       ipv4_unicast: true
#       route_target:
#         filter: true
#     graceful_shutdown:
#       community: '100'
#       local_preference: 100
#       neighbors:
#         time: 50
#     log_neighbor_changes: true
#     nopeerup_delay_options:
#       post_boot: 10
#   neighbors:
#   - aigp:
#       send:
#         cost_community:
#           id: 100
#           poi:
#             igp_cost: true
#             transitive: true
#     description: merge neighbor
#     neighbor_address: 192.0.2.1
#     remote_as: '100'
#     route_maps:
#     - name: test-route
#       out: true
# commands:
# - router bgp 65000
# - no bgp advertise-best-external
# - no bgp bestpath compare-routerid
# - no bgp dampening 1 1 1 1
# - no bgp graceful-shutdown all neighbors 50 local-preference 100 community 100
# - no bgp log-neighbor-changes
# - no bgp nopeerup-delay post-boot 10
# - no neighbor 192.0.2.1
# after:
#   as_number: '65000'

# After state:
# -------------
#
# vios#sh running-config | section ^router bgp
# router bgp 65000

# Using Deleted without any config passed

# Before state:
# -------------
#
# vios#sh running-config | section ^router bgp
# router bgp 65000
#  bgp nopeerup-delay post-boot 10
#  bgp graceful-shutdown all neighbors 50 local-preference 100 community 100
#  bgp bestpath compare-routerid
#  bgp dampening 1 1 1 1
#  bgp advertise-best-external
#  neighbor 192.0.2.1 remote-as 100
#  neighbor 192.0.2.1 description merge neighbor
#  neighbor 192.0.2.1 aigp send cost-community 100 poi igp-cost transitive
#  neighbor 192.0.2.1 route-map test-route out

- name: Delete global BGP without config
  cisco.ios.ios_bgp_global:
    state: deleted

# Task Output:
# ------------
#
# before:
#   as_number: '65000'
#   bgp:
#     advertise_best_external: true
#     bestpath_options:
#       compare_routerid: true
#     dampening:
#       max_suppress: 1
#       penalty_half_time: 1
#       reuse_route_val: 1
#       suppress_route_val: 1
#     default:
#       ipv4_unicast: true
#       route_target:
#         filter: true
#     graceful_shutdown:
#       community: '100'
#       local_preference: 100
#       neighbors:
#         time: 50
#     log_neighbor_changes: true
#     nopeerup_delay_options:
#       post_boot: 10
#   neighbors:
#   - aigp:
#       send:
#         cost_community:
#           id: 100
#           poi:
#             igp_cost: true
#             transitive: true
#     description: merge neighbor
#     neighbor_address: 192.0.2.1
#     remote_as: '100'
#     route_maps:
#     - name: test-route
#       out: true
# commands:
# - router bgp 65000
# - no bgp advertise-best-external
# - no bgp bestpath compare-routerid
# - no bgp dampening 1 1 1 1
# - no bgp graceful-shutdown all neighbors 50 local-preference 100 community 100
# - no bgp nopeerup-delay post-boot 10
# - no neighbor 198.51.100.1
# after:
#   as_number: '65000'

# After state:
# -------------
#
# vios#sh running-config | section ^router bgp
# router bgp 65000

# Using purged - would delete all configuration

# Before state:
# -------------
#
# vios#sh running-config | section ^router bgp
# router bgp 65000
#  bgp nopeerup-delay post-boot 10
#  bgp graceful-shutdown all neighbors 50 local-preference 100 community 100
#  bgp bestpath compare-routerid
#  bgp dampening 1 1 1 1
#  bgp advertise-best-external
#  neighbor 192.0.2.1 remote-as 100
#  neighbor 192.0.2.1 description merge neighbor
#  neighbor 192.0.2.1 aigp send cost-community 100 poi igp-cost transitive
#  neighbor 192.0.2.1 route-map test-route out

- name:
    "Delete the configured global BGP (Note: This WILL delete the the configured
    global BGP)"
  cisco.ios.ios_bgp_global:
    state: purged

# Task Output:
# ------------
#
# before:
#   as_number: '65000'
#   bgp:
#     advertise_best_external: true
#     bestpath_options:
#       compare_routerid: true
#     default:
#       ipv4_unicast: true
#       route_target:
#         filter: true
#     dampening:
#       max_suppress: 1
#       penalty_half_time: 1
#       reuse_route_val: 1
#       suppress_route_val: 1
#     graceful_shutdown:
#       community: '100'
#       local_preference: 100
#       neighbors:
#         time: 50
#     log_neighbor_changes: true
#     nopeerup_delay_options:
#       post_boot: 10
#   neighbors:
#   - aigp:
#       send:
#         cost_community:
#           id: 100
#           poi:
#             igp_cost: true
#             transitive: true
#     description: merge neighbor
#     neighbor_address: 192.0.2.1
#     remote_as: '100'
#     route_maps:
#     - name: test-route
#       out: true
# commands:
#  - no router bgp 65000
# after: {}

# After state:
# -------------
#
# vios#sh running-config | section ^router bgp

# Using gathered

# Before state:
# -------------
#
# vios#sh running-config | section ^router bgp
# router bgp 65000
#  bgp log-neighbor-changes
#  bgp nopeerup-delay post-boot 10
#  bgp graceful-shutdown all neighbors 50 local-preference 100 community 100
#  bgp bestpath compare-routerid
#  bgp dampening 1 1 1 1
#  bgp advertise-best-external
#  network 192.0.2.3
#  timers bgp 100 200 150
#  redistribute connected metric 10
#  neighbor 192.0.2.1 remote-as 100
#  neighbor 192.0.2.1 description merge neighbor
#  neighbor 192.0.2.1 aigp send cost-community 100 poi igp-cost transitive
#  neighbor 192.0.2.1 route-map test-route out

- name: Gather facts for bgp_global
  cisco.ios.ios_bgp_global:
    config:
    state: gathered

# Task Output:
# ------------
#
# gathered:
#   as_number: '65000'
#   bgp:
#     advertise_best_external: true
#     bestpath_options:
#       compare_routerid: true
#     dampening:
#       max_suppress: 1
#       penalty_half_time: 1
#       reuse_route_val: 1
#       suppress_route_val: 1
#     default:
#       ipv4_unicast: true
#       route_target:
#         filter: true
#     graceful_shutdown:
#       community: '100'
#       local_preference: 100
#       neighbors:
#         time: 50
#     log_neighbor_changes: true
#     nopeerup_delay_options:
#       post_boot: 10
#   neighbors:
#   - aigp:
#       send:
#         cost_community:
#           id: 100
#           poi:
#             igp_cost: true
#             transitive: true
#     description: merge neighbor
#     neighbor_address: 192.0.2.1
#     remote_as: '100'
#     route_maps:
#     - name: test-route
#       out: true
#   networks:
#   - address: 192.0.2.3
#   redistribute:
#   - connected:
#       metric: 10
#       set: true
#   timers:
#     holdtime: 200
#     keepalive: 100
#     min_holdtime: 150

# Using Rendered

- name: Rendered the provided configuration with the existing running configuration
  cisco.ios.ios_bgp_global:
    config:
      aggregate_addresses:
        - address: 192.0.2.1
          attribute_map: testMap1
          netmask: 255.255.255.0
          summary_only: true
        - address: 192.0.2.2
          as_set: true
          netmask: 255.255.255.0
        - address: 192.0.2.3
          as_set: true
          netmask: 255.255.255.0
      as_number: "65000"
      auto_summary: true
      bgp:
        additional_paths:
          install: true
          receive: true
        aggregate_timer: 0
        always_compare_med: true
        asnotation: true
        bestpath_options:
          aigp: true
          compare_routerid: true
          med:
            confed: true
            missing_as_worst: true
        confederation:
          identifier: "22"
        consistency_checker:
          error_message:
            interval: 10
            set: true
        dampening:
          route_map: routeMap1Test
        deterministic_med: true
        graceful_restart:
          restart_time: 2
          stalepath_time: 22
        graceful_shutdown:
          community: "77"
          local_preference: 230
          vrfs:
            time: 31
        inject_maps:
          - copy_attributes: true
            exist_map_name: Testmap3
            name: map2
          - copy_attributes: true
            exist_map_name: Testmap2
            name: map1
        listen:
          limit: 200
          range:
            host_with_subnet: 192.0.2.1/24
            peer_group: PaulNetworkGroup
        log_neighbor_changes: true
        maxas_limit: 2
        maxcommunity_limit: 3
        maxextcommunity_limit: 3
        nexthop:
          route_map: RouteMap1
          trigger:
            delay: 2
        nopeerup_delay_options:
          cold_boot: 2
          nsf_switchover: 10
          post_boot: 22
          user_initiated: 22
        recursion: true
        redistribute_internal: true
        refresh:
          max_eor_time: 700
          stalepath_time: 800
        router_id:
          vrf: true
        scan_time: 22
        slow_peer:
          detection:
            threshold: 345
          split_update_group:
            dynamic: true
            permanent: true
        sso: true
        suppress_inactive: true
        update_delay: 2
        update_group: true
      bmp:
        buffer_size: 22
        server: 2
      distance:
        bgp:
          routes_external: 2
          routes_internal: 3
          routes_local: 4
        mbgp:
          routes_external: 2
          routes_internal: 3
          routes_local: 5
      distributes:
        - in: true
          prefix: prefixTest
        - gateway: gatewayTest
          out: true
        - acl: "300"
          interface: Loopback0
          out: true
      maximum_paths:
        ibgp: 2
        paths: 2
      maximum_secondary_paths:
        ibgp: 22
        paths: 22
      neighbors:
        - neighbor_address: 192.0.2.10
          remote_as: "64500"
          update_source: Loopback1
        - activate: true
          neighbor_address: 192.0.2.11
          remote_as: "45000"
          send_community:
            extended: true
        - activate: true
          neighbor_address: 192.0.2.12
          remote_as: "45000"
        - neighbor_address: 192.0.2.13
          remote_as: "6553601"
        - advertise:
            diverse_path:
              backup: true
          neighbor_address: 192.0.2.8
          route_reflector_client: true
        - neighbor_address: 192.0.2.9
          remote_as: "64500"
          route_maps:
            - in: true
              name: rmp1
            - in: true
              name: rmp2
          update_source: Loopback0
        - activate: true
          advertise:
            additional_paths:
              group_best: true
          neighbor_address: 2001:DB8::1037
        - neighbor_address: testNebTag
          peer_group: "5"
          soft_reconfiguration: true
          version: 4
      networks:
        - address: 192.0.2.15
          backdoor: true
          netmask: 55.255.255.0
          route_map: mp1
        - address: 192.0.2.16
          backdoor: true
          netmask: 255.255.255.0
          route_map: mp2
        - address: 192.0.2.17
          backdoor: true
          netmask: 255.255.255.0
          route_map: mp2
      redistribute:
        - static:
            metric: 33
            route_map: rmp1
            set: true
        - application:
            metric: 22
            name: app1
        - application:
            metric: 33
            name: app2
            route_map: mp1
        - connected:
            metric: 22
            set: true
        - mobile:
            metric: 211
            set: true
    state: rendered

# Task Output:
# ------------
#
# rendered:
# - router bgp 65000
# - auto-summary
# - bmp buffer-size 22
# - bmp server 2
# - distance bgp 2 3 4
# - distance mbgp 2 3 5
# - maximum-paths 2
# - maximum-paths ibgp 2
# - maximum-secondary-paths 22
# - maximum-secondary-paths ibgp 22
# - bgp additional-paths install receive
# - bgp aggregate-timer 0
# - bgp always-compare-med
# - bgp asnotation dot
# - bgp bestpath aigp ignore
# - bgp bestpath compare-routerid
# - bgp bestpath med confed missing-as-worst
# - bgp confederation identifier 22
# - bgp consistency-checker error-message interval 10
# - bgp dampening route-map routeMap1Test
# - bgp deterministic-med
# - bgp graceful-restart restart-time 2
# - bgp graceful-restart stalepath-time 22
# - bgp graceful-shutdown all vrfs 31 local-preference 230 community 77
# - bgp listen limit 200
# - bgp listen range 192.0.2.1/24 peer-group PaulNetworkGroup
# - bgp log-neighbor-changes
# - bgp maxas-limit 2
# - bgp maxcommunity-limit 3
# - bgp maxextcommunity-limit 3
# - bgp nexthop route-map RouteMap1
# - bgp nexthop trigger delay 2
# - bgp nopeerup-delay cold-boot 2
# - bgp nopeerup-delay post-boot 22
# - bgp nopeerup-delay nsf-switchover 10
# - bgp nopeerup-delay user-initiated 22
# - bgp recursion host
# - bgp redistribute-internal
# - bgp refresh max-eor-time 700
# - bgp refresh stalepath-time 800
# - bgp router-id vrf auto-assign
# - bgp scan-time 22
# - bgp slow-peer detection threshold 345
# - bgp slow-peer split-update-group dynamic permanent
# - bgp sso route-refresh-enable
# - bgp suppress-inactive
# - bgp update-delay 2
# - bgp update-group split as-override
# - bgp inject-map map2 exist-map Testmap3 copy-attributes
# - bgp inject-map map1 exist-map Testmap2 copy-attributes
# - distribute-list prefix prefixTest in
# - distribute-list gateway gatewayTest out
# - distribute-list 300 out Loopback0
# - aggregate-address 192.0.2.1 255.255.255.0 summary-only attribute-map testMap1
# - aggregate-address 192.0.2.2 255.255.255.0 as-set
# - aggregate-address 192.0.2.3 255.255.255.0 as-set
# - network 192.0.2.15 mask 55.255.255.0 route-map mp1 backdoor
# - network 192.0.2.16 mask 255.255.255.0 route-map mp2 backdoor
# - network 192.0.2.17 mask 255.255.255.0 route-map mp2 backdoor
# - neighbor 192.0.2.10 remote-as 64500
# - neighbor 192.0.2.10 update-source Loopback1
# - neighbor 192.0.2.11 remote-as 45000
# - neighbor 192.0.2.11 activate
# - neighbor 192.0.2.11 send-community extended
# - neighbor 192.0.2.12 remote-as 45000
# - neighbor 192.0.2.12 activate
# - neighbor 192.0.2.13 remote-as 6553601
# - neighbor 192.0.2.8 advertise diverse-path backup
# - neighbor 192.0.2.8 route-reflector-client
# - neighbor 192.0.2.9 remote-as 64500
# - neighbor 192.0.2.9 update-source Loopback0
# - neighbor 192.0.2.9 route-map rmp1 in
# - neighbor 192.0.2.9 route-map rmp2 in
# - neighbor 2001:DB8::1037 activate
# - neighbor 2001:DB8::1037 advertise additional-paths group-best
# - neighbor testNebTag peer-group 5
# - neighbor testNebTag soft-reconfiguration inbound
# - neighbor testNebTag version 4
# - redistribute static metric 33 route-map rmp1
# - redistribute application app1 metric 22
# - redistribute application app2 metric 33 route-map mp1
# - redistribute connected metric 22
# - redistribute mobile metric 211

# Using parsed

# File: parsed.cfg
# ----------------
#
# router bgp 65000
#  auto-summary
#  bmp buffer-size 22
#  bmp server 2
#  distance bgp 2 3 4
#  distance mbgp 2 3 5
#  maximum-paths 2
#  maximum-paths ibgp 2
#  maximum-secondary-paths 22
#  maximum-secondary-paths ibgp 22
#  description checking description as line
#  bgp additional-paths install receive
#  bgp aggregate-timer 0
#  bgp always-compare-med
#  bgp asnotation dot
#  bgp bestpath aigp ignore
#  bgp bestpath compare-routerid
#  bgp bestpath med confed missing-as-worst
#  bgp confederation identifier 22
#  bgp consistency-checker error-message interval 10
#  bgp dampening route-map routeMap1Test
#  bgp deterministic-med
#  bgp graceful-restart restart-time 2
#  bgp graceful-restart stalepath-time 22
#  bgp graceful-shutdown all vrfs 31 local-preference 230 community 77
#  bgp listen limit 200
#  bgp listen range 192.0.2.1/24 peer-group PaulNetworkGroup
#  bgp log-neighbor-changes
#  bgp maxas-limit 2
#  bgp maxcommunity-limit 3
#  bgp maxextcommunity-limit 3
#  bgp nexthop route-map RouteMap1
#  bgp nexthop trigger delay 2
#  bgp nopeerup-delay cold-boot 2
#  bgp nopeerup-delay post-boot 22
#  bgp nopeerup-delay nsf-switchover 10
#  bgp nopeerup-delay user-initiated 22
#  bgp recursion host
#  bgp redistribute-internal
#  bgp refresh max-eor-time 700
#  bgp refresh stalepath-time 800
#  bgp router-id vrf auto-assign
#  bgp scan-time 22
#  bgp slow-peer detection threshold 345
#  bgp slow-peer split-update-group dynamic permanent
#  bgp sso route-refresh-enable
#  bgp suppress-inactive
#  bgp update-delay 2
#  bgp update-group split as-override
#  bgp inject-map map2 exist-map Testmap3 copy-attributes
#  bgp inject-map map1 exist-map Testmap2 copy-attributes
#  distribute-list prefix prefixTest in
#  distribute-list gateway gatewayTest out
#  distribute-list 300 out Loopback0
#  aggregate-address 192.0.2.1 255.255.255.0 summary-only attribute-map testMap1
#  aggregate-address 192.0.2.2 255.255.255.0 as-set
#  aggregate-address 192.0.2.3 255.255.255.0 as-set
#  network 192.0.2.15 mask 55.255.255.0 route-map mp1 backdoor
#  network 192.0.2.16 mask 255.255.255.0 route-map mp2 backdoor
#  network 192.0.2.17 mask 255.255.255.0 route-map mp2 backdoor
#  neighbor 192.0.2.8 advertise diverse-path backup
#  neighbor 192.0.2.8 route-reflector-client
#  neighbor 192.0.2.9 remote-as 64500
#  neighbor 192.0.2.9 update-source Loopback0
#  neighbor 192.0.2.9 route-map rmp1 in
#  neighbor 192.0.2.9 route-map rmp2 in
#  neighbor 192.0.2.10 remote-as 64500
#  neighbor 192.0.2.10 update-source Loopback1
#  neighbor 192.0.2.11 remote-as 45000
#  neighbor 192.0.2.11 activate
#  neighbor 192.0.2.11 send-community extended
#  neighbor 192.0.2.12 remote-as 45000
#  neighbor 192.0.2.12 activate
#  neighbor 192.0.2.13 remote-as 6553601
#  neighbor 192.0.2.13 shutdown graceful 10 community 20
#  neighbor 2001:DB8::1037 activate
#  neighbor 2001:DB8::1037 advertise additional-paths group-best
#  neighbor testNebTag peer-group 5
#  neighbor testNebTag soft-reconfiguration inbound
#  neighbor testNebTag version 4
#  redistribute static metric 33 route-map rmp1
#  redistribute application app1 metric 22
#  redistribute application app2 metric 33 route-map mp1
#  redistribute connected metric 22
#  redistribute mobile metric 21

- name: Parse the commands for provided configuration
  cisco.ios.ios_bgp_global:
    running_config: "{{ lookup('file', 'parsed.cfg') }}"
    state: parsed

# Task Output:
# ------------
#
# parsed:
#     aggregate_addresses:
#     - address: 192.0.2.1
#       attribute_map: testMap1
#       netmask: 255.255.255.0
#       summary_only: true
#     - address: 192.0.2.2
#       as_set: true
#       netmask: 255.255.255.0
#     - address: 192.0.2.3
#       as_set: true
#       netmask: 255.255.255.0
#     as_number: '65000'
#     auto_summary: true
#     bgp:
#       additional_paths:
#         install: true
#         receive: true
#       aggregate_timer: 0
#       always_compare_med: true
#       asnotation: true
#       bestpath_options:
#         aigp: true
#         compare_routerid: true
#         med:
#           confed: true
#           missing_as_worst: true
#       confederation:
#         identifier: '22'
#       consistency_checker:
#         error_message:
#           interval: 10
#           set: true
#       dampening:
#         route_map: routeMap1Test
#       deterministic_med: true
#       graceful_restart:
#         restart_time: 2
#         stalepath_time: 22
#       graceful_shutdown:
#         community: '77'
#         local_preference: 230
#         vrfs:
#           time: 31
#       inject_maps:
#       - copy_attributes: true
#         exist_map_name: Testmap3
#         name: map2
#       - copy_attributes: true
#         exist_map_name: Testmap2
#         name: map1
#       listen:
#         limit: 200
#         range:
#           host_with_subnet: 192.0.2.1/24
#           peer_group: PaulNetworkGroup
#       log_neighbor_changes: true
#       maxas_limit: 2
#       maxcommunity_limit: 3
#       maxextcommunity_limit: 3
#       nexthop:
#         route_map: RouteMap1
#         trigger:
#           delay: 2
#       nopeerup_delay_options:
#         cold_boot: 2
#         nsf_switchover: 10
#         post_boot: 22
#         user_initiated: 22
#       recursion: true
#       redistribute_internal: true
#       refresh:
#         max_eor_time: 700
#         stalepath_time: 800
#       router_id:
#         vrf: true
#       scan_time: 22
#       slow_peer:
#         detection:
#           threshold: 345
#         split_update_group:
#           dynamic: true
#           permanent: true
#       sso: true
#       suppress_inactive: true
#       update_delay: 2
#       update_group: true
#     bmp:
#       buffer_size: 22
#       server: 2
#     distance:
#       bgp:
#         routes_external: 2
#         routes_internal: 3
#         routes_local: 4
#       mbgp:
#         routes_external: 2
#         routes_internal: 3
#         routes_local: 5
#     distributes:
#     - in: true
#       prefix: prefixTest
#     - gateway: gatewayTest
#       out: true
#     - acl: '300'
#       interface: Loopback0
#       out: true
#     maximum_paths:
#       ibgp: 2
#       paths: 2
#     maximum_secondary_paths:
#       ibgp: 22
#       paths: 22
#     neighbors:
#     - neighbor_address: 192.0.2.10
#       remote_as: '64500'
#       update_source: Loopback1
#     - activate: true
#       neighbor_address: 192.0.2.11
#       remote_as: '45000'
#       send_community:
#         extended: true
#     - activate: true
#       neighbor_address: 192.0.2.12
#       remote_as: '45000'
#     - neighbor_address: 192.0.2.13
#       remote_as: '6553601'
#     - advertise:
#         diverse_path:
#           backup: true
#       neighbor_address: 192.0.2.8
#       route_reflector_client: true
#     - neighbor_address: 192.0.2.9
#       remote_as: '64500'
#       route_maps:
#       - in: true
#         name: rmp1
#       - in: true
#         name: rmp2
#       update_source: Loopback0
#     - activate: true
#       advertise:
#         additional_paths:
#           group_best: true
#       neighbor_address: 2001:DB8::1037
#     - neighbor_address: testNebTag
#       peer_group: '5'
#       soft_reconfiguration: true
#       version: 4
#     networks:
#     - address: 192.0.2.15
#       backdoor: true
#       netmask: 55.255.255.0
#       route_map: mp1
#     - address: 192.0.2.16
#       backdoor: true
#       netmask: 255.255.255.0
#       route_map: mp2
#     - address: 192.0.2.17
#       backdoor: true
#       netmask: 255.255.255.0
#       route_map: mp2
#     redistribute:
#     - static:
#         metric: 33
#         route_map: rmp1
#         set: true
#     - application:
#         metric: 22
#         name: app1
#     - application:
#         metric: 33
#         name: app2
#         route_map: mp1
#     - connected:
#         metric: 22
#         set: true
#     - mobile:
#         metric: 21
#         set: true

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

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

Ключ

Описание

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 65000", "neighbor 198.51.100.1 aigp send cost-community 100 poi igp-cost transitive", "bgp graceful-shutdown all neighbors 50 local-preference 100 community 100"]

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 65000", "neighbor 198.51.100.1 aigp send cost-community 100 poi igp-cost transitive", "bgp graceful-shutdown all neighbors 50 local-preference 100 community 100"]

Авторы

  • Sumit Jaiswal (@justjais)
  • Sagar Paul (@KB-perByte)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 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/ios/ios_bgp_global_module.html

Spec-Zone.ru

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