cisco.nxos.nxos_bgp_af – Управляет конфигурацией семейства адресов BGP.
Примечание
Этот плагин входит в коллекцию cisco.nxos (версия 1.4.0).
Для его установки используйте: ansible-galaxy collection install cisco.nxos.
Для использования в плейбуке укажите: cisco.nxos.nxos_bgp_af.
Введено в версии 1.0.0: of cisco.nxos
Обзор
- Управляет конфигурациями семейств адресов BGP на коммутаторах NX-OS.
Примечание
Данный модуль имеет соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| additional_paths_install логический тип |
| Установка резервного пути в таблицу маршрутизации и обеспечение независимой конвергенции (PIC) в случае отказа канала PE-CE. | |
| additional_paths_receive логический тип |
| Включает возможность приема дополнительных путей для всех соседей в рамках данной адресной семьи, для которых эта возможность не отключена. | |
| additional_paths_selection строка | Настройка возможности выбора дополнительных путей для префикса. Допустимые значения — строка, определяющая имя карты маршрутизации. | ||
| additional_paths_send логический тип |
| Включает возможность отправки дополнительных путей для всех соседей в рамках данной адресной семьи, для которых эта возможность не отключена. | |
| advertise_l2vpn_evpn логический тип |
| Рекламировать маршруты evpn. | |
| afi строка / обязательно |
| Идентификатор адресной семьи. | |
| asn строка / обязательно | Номер автономной системы BGP. Допустимые значения — строка, целое число в ASPLAIN или ASDOT формате. | ||
| client_to_client логический тип |
| Настройка отражения маршрутов клиент-клиент. | |
| dampen_igp_metric строка | Указать значение затухания для изменений метрики IGP в секундах. Допустимые значения — целое число и ключевое слово «default». | ||
| dampening_half_time строка | Указать время полураспада в минутах для затухания колебаний маршрутов. Допустимые значения — целое число и ключевое слово «default». | ||
| dampening_max_suppress_time строка | Указать максимальное время подавления для стабильного маршрута с затуханием колебаний маршрутов. Допустимые значения — целое число и ключевое слово «default». | ||
| dampening_reuse_time строка | Указать время повторного использования маршрута для затухания колебаний маршрутов. Допустимые значения — целое число и ключевое слово «default». | ||
| dampening_routemap строка | Указать карту маршрутизации для затухания колебаний маршрутов. Допустимые значения — строка, определяющая имя карты маршрутизации. | ||
| dampening_state логический тип |
| Включить/отключить затухание колебаний маршрутов. | |
| dampening_suppress_time строка | Указать время подавления маршрута для затухания колебаний маршрутов. Допустимые значения — целое число и ключевое слово «default». | ||
| default_information_originate логический тип |
| Указать источник информации по умолчанию. | |
| default_metric строка | Устанавливает значения метрик по умолчанию для маршрутов, перераспределенных в BGP. Допустимые значения — целое число или ключевое слово «default» | ||
| distance_ebgp строка | Устанавливает административную дистанцию для маршрутов eBGP. Допустимые значения — целое число или ключевое слово «default». | ||
| distance_ibgp строка | Устанавливает административную дистанцию для маршрутов iBGP. Допустимые значения — целое число или ключевое слово «default». | ||
| distance_local строка | Устанавливает административную дистанцию для локальных маршрутов BGP. Допустимые значения — целое число или ключевое слово «default». | ||
| inject_map список / элементы=список | Массив имён карт маршрутизации, которые определяют префиксы для ввода. Каждый элемент массива должен содержать имя карты inject, имя карты exist и необязательное ключевое слово copy-attributes, указывающее на копирование атрибутов из агрегата. Например, [['lax_inject_map', 'lax_exist_map'], ['nyc_inject_map', 'nyc_exist_map', 'copy-attributes'], ['fsd_inject_map', 'fsd_exist_map']]. | ||
| maximum_paths строка | Настраивает максимальное количество путей с одинаковой стоимостью для распределения нагрузки. Допустимое значение — целое число в диапазоне от 1 до 64. | ||
| maximum_paths_ibgp строка | Настраивает максимальное количество путей iBGP с одинаковой стоимостью для распределения нагрузки. Допустимое значение — целое число в диапазоне от 1 до 64. | ||
| networks список / элементы=список | Маршруты для настройки. Допустимое значение — список префиксов сетевых адресов для рекламы. Список должен быть в виде массива. Каждый элемент массива должен содержать префикс адреса и необязательную карту маршрутизации. Например, [['10.0.0.0/16', 'routemap_LA'], ['192.168.1.1', 'Chicago'], ['192.168.2.0/24'], ['192.168.3.0/24', 'routemap_NYC']]. | ||
| next_hop_route_map строка | Настройка карты маршрутизации для допустимых следующих узлов. Допустимые значения — строка, определяющая имя карты маршрутизации. | ||
| provider словарь | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Начиная с Ansible 2.6, рекомендуется использовать connection: httpapi для NX-API.Этот параметр будет удален в релизе после 2022-06-01. Дополнительная информация в руководстве по платформе NXOS: Руководство по платформе NXOS. Объект словаря, содержащий данные подключения. | ||
| auth_pass строка | Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize — ложь, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения 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 строка |
| Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_proxy логический тип |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| use_ssl логический тип |
| Настраивает transport для использования SSL, если значение равно yes, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username строка | Настраивает имя пользователя для аутентификации соединения с удалённым устройством. Это значение используется для аутентификации входа CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверяющих сертификатов. Если аргумент transport не nxapi, это значение игнорируется. | |
| redistribute список / элементы=список | Список директив перераспределения. Разрешено несколько записей перераспределения. Список должен быть в форме вложенного массива. Первый элемент каждого массива определяет источник протокола для перераспределения; второй элемент определяет имя карты маршрутов. Карта маршрутов настоятельно рекомендуется, но может быть необязательной на некоторых платформах, в этом случае она может быть опущена из списка массивов. Например [['direct', 'rm_direct'], ['lisp', 'rm_lisp']]. | ||
| retain_route_target строка добавлено в версии 1.1.0 cisco.nxos | Сохраняет все маршруты или маршруты, которые являются частью сконфигурированной карты маршрутов. Допустимые значения — имена карт маршрутов или ключевое слово all или ключевое слово default. all сохраняет все маршруты независимо от сообщества Target-VPN. default отключит параметр сохранения целевого маршрута. Если вы используете имя карты маршрутов, убедитесь, что это имя не совпадает с all и default. | ||
| safi строка / обязательно |
| Идентификатор подсети. | |
| state строка |
| Определяет, должно ли конфигурация присутствовать на устройстве или нет. | |
| suppress_inactive boolean |
| Объявляет только активные маршруты peer. | |
| table_map строка | Применение table-map для фильтрации маршрутов, загружаемых в URIB. Допустимые значения — строка. | ||
| table_map_filter boolean |
| Фильтры маршрутов, отклоненных картой маршрутов, и не загружает их в RIB. | |
| vrf строка | По умолчанию: "default" | Имя VRF. Имя 'default' является допустимым VRF, представляющим глобальный bgp. | |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
-
state=absentудаляет всю конфигурацию BGP ASN - По умолчанию, где поддерживается, восстанавливает значения параметров по умолчанию.
- Дополнительная информация по использованию CLI и NX-API см. в руководстве NXOS Platform Options.
- Дополнительная информация по использованию Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide.
- Дополнительная информация по использованию Ansible для управления устройствами Cisco см. на странице интеграции Cisco https://www.ansible.com/integrations/networks/cisco.
Примеры
# configure a simple address-family
- cisco.nxos.nxos_bgp_af:
asn: 65535
vrf: TESTING
afi: ipv4
safi: unicast
advertise_l2vpn_evpn: true
state: present
retain_route_target: all
Значения возврата
Общие значения возврата описаны в разделе здесь, а следующие — уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список / элементы=строка | всегда | Команды, отправленные устройству Пример: ['router bgp 65535', 'vrf TESTING', 'address-family ipv4 unicast', 'advertise l2vpn evpn', 'retain route-target all'] |
Авторы
- 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_af_module.html
