cisco.nxos.nxos_bgp – (deprecated, removed after 2023-01-27) Управляет конфигурацией BGP.
Примечание
Этот плагин входит в коллекцию cisco.nxos (версия 1.4.0).
Для его установки используйте: ansible-galaxy collection install cisco.nxos.
Для использования в playbook, укажите: cisco.nxos.nxos_bgp.
Новое в версии 1.0.0: of cisco.nxos
УСТАРЕВШЕ
- Удалили в
-
главном релизе после 2023-01-27
- Почему
-
Выпущен обновлённый модуль с большей функциональностью.
- Альтернатива
-
nxos_bgp_global
Обзор
- Управляет конфигурациями 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 логическое |
| Включить/выключить принудительное установление автономной системы peer в качестве первого номера AS, указанного в атрибуте AS-path для eBGP. На NX-OS данная опция поддерживается только в глобальном контексте BGP. | |
| event_history_cli строка |
| Включить/выключить буфер истории событий CLI. | |
| event_history_detail строка |
| Включить/выключить буфер подробной истории событий. | |
| event_history_events строка |
| Включить/выключить буфер истории событий. | |
| event_history_periodic строка |
| Включить/выключить буфер периодической истории событий. | |
| fast_external_fallover логическое |
| Включить/выключить немедленное сброс сессии, если соединение с напрямую подключённым BGP peer прерывается. Поддерживается только в глобальном контексте BGP. | |
| flush_routes логическое |
| Включить/выключить очистку маршрутов в RIB при контролируемом перезапуске. На NX-OS данная опция поддерживается только в глобальном контексте BGP. | |
| graceful_restart логическое |
| Включить/выключить плавный перезапуск. | |
| graceful_restart_helper логическое |
| Включить/выключить режим помощника плавного перезапуска. | |
| graceful_restart_timers_restart строка | Установить максимальное время для отправки запроса на перезапуск peer BGP. | ||
| graceful_restart_timers_stalepath_time строка | Установить максимальное время, в течение которого BGP хранит устаревшие маршруты от перезапускающего BGP peer. | ||
| isolate логическое |
| Включить/выключить изоляцию этого маршрутизатора с точки зрения BGP. | |
| local_as строка | Местный номер AS, который будет использоваться в пределах экземпляра VRF. | ||
| log_neighbor_changes логическое |
| Включить/выключить протоколирование сообщений об изменениях peer-соединения (up/down). | |
| maxas_limit строка | Указать максимальное количество номеров AS, разрешённых в атрибуте AS-path. Допустимые значения — от 1 до 512. | ||
| neighbor_down_fib_accelerate логическое |
| Включить/выключить обработку событий BGP neighbor down по разным причинам. | |
| provider словарь | Устарело Начиная с Ansible 2.5, рекомендуем использовать connection: network_cli. Начиная с Ansible 2.6, рекомендуем использовать connection: httpapi для NX-API.Данная опция будет удалена в выпуске после 2022-06-01. Для получения дополнительной информации, пожалуйста, обратитесь к руководству по опциям платформы NXOS NXOS Platform Options. Объект словаря, содержащий сведения о подключении. | ||
| 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" | Имя 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 Platform Options
- Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. руководство Ansible Network Guide
- Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco см. страницу интеграции Cisco Cisco integration page.
Примеры
- 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'] |
Статус
- Этот модуль будет удалён в основной версии после 2023-01-27. [устарел]
- Для получения дополнительной информации см. УСТАРЕЛО.
Авторы
- Jason Edelman (@jedelman8)
- Gabriele Gerbino (@GGabriele)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/nxos/nxos_bgp_module.html