cisco.nxos.nxos_bgp – Управляет конфигурацией BGP.
Примечание
Этот плагин входит в коллекцию cisco.nxos (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install cisco.nxos.
Для использования в книге задач укажите: cisco.nxos.nxos_bgp.
Новое в версии 1.0.0: плагина cisco.nxos
Обзор
- Управляет конфигурацией BGP на коммутаторах NX-OS.
Примечание
Данный модуль имеет соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| asn строка / обязательно | Номер автономной системы BGP. Допустимые значения — строка, целое число в ASPLAIN или ASDOT формате. | ||
| bestpath_always_compare_med логическое значение |
| Включить/выключить сравнение MED на путях из разных автономных систем. | |
| bestpath_aspath_multipath_relax логическое значение |
| Включить/выключить распределение нагрузки между поставщиками с разными (но одинаковой длины) AS-путями. | |
| bestpath_compare_neighborid логическое значение |
| Включить/выключить сравнение neighborid. Используйте, когда доступно больше путей, чем максимальная конфигурация путей. | |
| bestpath_compare_routerid логическое значение |
| Включить/выключить сравнение идентификаторов маршрутизаторов для идентичных путей eBGP. | |
| bestpath_cost_community_ignore логическое значение |
| Включить/выключить игнорирование сообщества стоимости для расчета лучшего пути BGP. | |
| bestpath_med_confed логическое значение |
| Включить/выключить применение bestpath для сравнения MED только между путями, исходящими из конфедерации. | |
| bestpath_med_missing_as_worst логическое значение |
| Включить/выключить присвоение значения бесконечности полученным маршрутам, которые не содержат атрибут MED, что делает эти маршруты наименее предпочтительными. | |
| bestpath_med_non_deterministic логическое значение |
| Включить/выключить детерминированный выбор лучшего пути MED среди путей из одной автономной системы. | |
| cluster_id строка | Идентификатор кластера отражателя маршрутов. | ||
| confederation_id строка | Конфедерация домена маршрутизации AS. | ||
| confederation_peers список / элементы=строка | Параметры конфедерации AS. | ||
| disable_policy_batching логическое значение |
| Включить/выключить пакетную оценку объявления префиксов всем peer. | |
| disable_policy_batching_ipv4_prefix_list строка | Включить/выключить пакетную оценку объявлений префиксов всем peer с списком префиксов. | ||
| disable_policy_batching_ipv6_prefix_list строка | Включить/выключить пакетную оценку объявлений префиксов всем peer с списком префиксов. | ||
| enforce_first_as логическое значение |
| Включить/выключить принудительный порядок автономной системы соседа, как первой в списке AS-пути для eBGP. В NX-OS данная опция поддерживается только в глобальном контексте BGP. | |
| event_history_cli строка |
| Включить/выключить буфер истории событий CLI. | |
| event_history_detail строка |
| Включить/выключить буфер подробной истории событий. | |
| event_history_events строка |
| Включить/выключить буфер истории событий. | |
| event_history_periodic строка |
| Включить/выключить буфер периодической истории событий. | |
| fast_external_fallover логическое значение |
| Включить/выключить немедленное сброс сессии, если соединение с напрямую подключенным peer BGP прерывается. Поддерживается только в глобальном контексте BGP. | |
| flush_routes логическое значение |
| Включить/выключить очистку маршрутов в RIB при управляемом перезапуске. В NX-OS данная опция поддерживается только в глобальном контексте BGP. | |
| graceful_restart логическое значение |
| Включить/выключить плавный перезапуск. | |
| graceful_restart_helper логическое значение |
| Включить/выключить вспомогательный режим плавного перезапуска. | |
| graceful_restart_timers_restart строка | Установить максимальное время для отправки запроса на перезапуск peer BGP. | ||
| graceful_restart_timers_stalepath_time строка | Установить максимальное время, в течение которого BGP хранит устаревшие маршруты от перезапускаемого peer BGP. | ||
| isolate логическое значение |
| Включить/выключить изоляцию этого маршрутизатора с точки зрения BGP. | |
| local_as строка | Локальный номер AS, используемый в экземпляре VRF. | ||
| log_neighbor_changes логическое значение |
| Включить/выключить логирование сообщений о событиях подключения/отключения соседа. | |
| maxas_limit строка | Указать максимальное количество номеров AS, разрешенных в атрибуте AS-пути. Допустимые значения — от 1 до 512. | ||
| neighbor_down_fib_accelerate логическое значение |
| Включить/выключить обработку события отключения соседа BGP по различным причинам. | |
| provider словарь | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Начиная с Ansible 2.6, рекомендуется использовать connection: httpapi для NX-API.Эта опция будет удалена в версии после 2022-06-01. Для получения дополнительной информации, пожалуйста, обратитесь к Руководству по платформе NXOS. Объект словаря, содержащий данные соединения. | ||
| auth_pass строка | Указывает пароль, используемый для входа в привилегированный режим на удаленном устройстве. Если authorize — false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize логическое значение |
| Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host строка | Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному каналу связи. Значение host используется в качестве адреса назначения для канала связи. | ||
| password строка | Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для каналов связи cli или nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port целое число | Указывает порт для подключения к удаленному устройству. Это значение относится к каналам связи cli или nxapi. Значение порта по умолчанию устанавливается для соответствующего общего порта канала связи, если он не указан в задаче (cli=22, http=80, https=443). | ||
| ssh_keyfile строка | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для канала связи cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль сообщит об ошибке. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т. д.). | ||
| transport string |
| Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_proxy boolean |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| use_ssl boolean |
| Настраивает transport для использования SSL, если значение установлено в yes, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username string | Настраивает имя пользователя для аутентификации соединения с удалённым устройством. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых пользователем сайтах, использующих самозаверенные сертификаты. Если аргумент transport не равен nxapi, это значение игнорируется. | |
| reconnect_interval string | Интервал повторного подключения BGP для прерванных сессий. Допустимые значения находятся в диапазоне от 1 до 60. | ||
| router_id string | Идентификатор маршрутизатора (ID) экземпляра VRF маршрутизатора BGP. | ||
| shutdown boolean |
| Административное отключение протокола BGP. | |
| state string |
| Определяет, должен ли конфигурационный параметр присутствовать на устройстве или нет. | |
| suppress_fib_pending boolean |
| Включить/выключить рекламу только маршрутов, запрограммированных в оборудовании, peer'ам. | |
| timer_bestpath_limit string | Укажите время ожидания первого лучшего пути после перезапуска в секундах. | ||
| timer_bgp_hold string | Установите таймер удержания BGP. | ||
| timer_bgp_keepalive string | Установите таймер keepalive BGP. | ||
| vrf string | Default: "default" | Имя VRF. Имя 'default' является допустимым VRF, представляющим глобальный BGP. | |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
-
state=absentудаляет всю конфигурацию ASN BGP приvrf=defaultили весь экземпляр VRF внутри процесса BGP при использовании другого VRF. - По умолчанию при поддержке восстанавливаются значения параметров по умолчанию.
- Настройка глобальных параметров разрешена только если
vrf=default. - Для получения информации об использовании CLI и NX-API см. Руководство по параметрам платформы NXOS
- Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. Руководство по сети Ansible
- Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco см. страницу интеграции Cisco https://www.ansible.com/integrations/networks/cisco.
Примеры
- name: Configure a simple ASN
cisco.nxos.nxos_bgp:
asn: 65535
vrf: test
router_id: 192.0.2.1
state: present
Значения возврата
Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| commands list / elements=string | всегда | Команды, отправленные на устройство Пример: ['router bgp 65535', 'vrf test', 'router-id 192.0.2.1'] |
Авторы
- Jason Edelman (@jedelman8)
- Gabriele Gerbino (@GGabriele)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/nxos/nxos_bgp_module.html
