cisco.nxos.nxos_bgp_af – Управляет настройкой семейства адресов BGP.
Примечание
Этот плагин входит в коллекцию cisco.nxos (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install cisco.nxos.
Для использования в плейбуке укажите: cisco.nxos.nxos_bgp_af.
Новое в версии 1.0.0: of cisco.nxos
Обзор
- Управляет конфигурацией семейств адресов BGP на коммутаторах NX-OS.
Примечание
Для данного модуля существует соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| additional_paths_install boolean |
| Устанавливает резервный путь в таблицу переадресации и обеспечивает независимую конвергенцию префиксов (PIC) в случае отказа соединения PE-CE. | |
| additional_paths_receive boolean |
| Включает возможность приема дополнительных путей для всех соседей в рамках этой адресной семьи, для которых эта возможность не отключена. | |
| additional_paths_selection string | Настраивает возможность выбора дополнительных путей для префикса. Допустимые значения — строка, определяющая имя карты маршрутизации. | ||
| additional_paths_send boolean |
| Включает возможность отправки дополнительных путей для всех соседей в рамках этой адресной семьи, для которых эта возможность не отключена. | |
| advertise_l2vpn_evpn boolean |
| Рекламировать маршруты evpn. | |
| afi string / обязательно |
| Идентификатор адресной семьи. | |
| asn string / обязательно | Номер автономной системы BGP. Допустимые значения — строка, целое число в обозначениях ASPLAIN или ASDOT. | ||
| client_to_client boolean |
| Настройка отражения маршрутов клиент-клиент. | |
| dampen_igp_metric string | Указывает значение демпфирования для изменений метрики IGP в секундах. Допустимые значения — целое число и ключевое слово «default». | ||
| dampening_half_time string | Указывает время полураспада в минутах для демпфирования колебаний маршрутов. Допустимые значения — целое число и ключевое слово «default». | ||
| dampening_max_suppress_time string | Указывает максимальное время подавления стабильного маршрута для демпфирования колебаний маршрутов. Допустимые значения — целое число и ключевое слово «default». | ||
| dampening_reuse_time string | Указывает время повторного использования маршрута для демпфирования колебаний маршрутов. Допустимые значения — целое число и ключевое слово «default». | ||
| dampening_routemap string | Указывает карту маршрутизации для демпфирования колебаний маршрутов. Допустимые значения — строка, определяющая имя карты маршрутизации. | ||
| dampening_state boolean |
| Включение/выключение демпфирования колебаний маршрутов. | |
| dampening_suppress_time string | Указывает время подавления маршрута для демпфирования колебаний маршрутов. Допустимые значения — целое число и ключевое слово «default». | ||
| default_information_originate boolean |
| Указывает на источник информации по умолчанию. | |
| default_metric string | Устанавливает значения метрик по умолчанию для маршрутов, перераспределенных в BGP. Допустимые значения — целое число или ключевое слово «default». | ||
| distance_ebgp string | Устанавливает административную дистанцию для маршрутов eBGP. Допустимые значения — целое число или ключевое слово «default». | ||
| distance_ibgp string | Устанавливает административную дистанцию для маршрутов iBGP. Допустимые значения — целое число или ключевое слово «default». | ||
| distance_local string | Устанавливает административную дистанцию для локальных маршрутов BGP. Допустимые значения — целое число или ключевое слово «default». | ||
| inject_map list / elements=list | Массив имен карт маршрутизации, которые определят префиксы для вставки. Каждый элемент массива должен в первую очередь содержать имя карты вставки, затем имя карты существования и необязательно ключевое слово copy-attributes, которое указывает на копирование атрибутов из агрегата. Например, [['lax_inject_map', 'lax_exist_map'], ['nyc_inject_map', 'nyc_exist_map', 'copy-attributes'], ['fsd_inject_map', 'fsd_exist_map']]. | ||
| maximum_paths string | Настройка максимального числа путей с равной стоимостью для балансировки нагрузки. Допустимое значение — целое число в диапазоне от 1 до 64. | ||
| maximum_paths_ibgp string | Настройка максимального числа путей iBGP с равной стоимостью для балансировки нагрузки. Допустимое значение — целое число в диапазоне от 1 до 64. | ||
| networks list / elements=list | Маршруты для настройки. Допустимое значение — список префиксов сетевых адресов для рекламы. Список должен иметь формат массива. Каждый элемент массива должен содержать адрес префикса и необязательную карту маршрутизации. Например, [['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 string | Настройка карты маршрутизации для допустимых следующей узлов. Допустимые значения — строка, определяющая имя карты маршрутизации. | ||
| provider dictionary | Устаревшее Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Начиная с Ansible 2.6, для NX-API рекомендуется использовать connection: httpapi. Этот параметр будет удален в релизе после 2022-06-01. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект словаря, содержащий данные подключения. | ||
| auth_pass string | Указывает пароль, используемый при необходимости для входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, этот аргумент не используется. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize boolean |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host string | Указывает имя или адрес хоста DNS для подключения к удалённому устройству через указанный транспорт. Значение host используется как адрес назначения для транспорта. | ||
| password string | Указывает пароль для аутентификации подключения к удалённому устройству. Этот аргумент обычно используется для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port integer | Указывает порт для подключения к удалённому устройству. Это значение применимо к cli или nxapi. Если значение порта не указано в задаче, используется стандартный порт для соответствующего транспорта (cli=22, http=80, https=443). | ||
| ssh_keyfile string | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout integer | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль вернёт ошибку. 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, это значение игнорируется. | |
| redistribute список / элементы=список | Список директив redistribute. Разрешено несколько записей 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 |
| Опубликует только активные маршруты для пиров. | |
| 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 Cisco integration.
Примеры
# 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–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_af_module.html