cisco.nxos.nxos_bgp_neighbor_af – Управляет конфигурацией соседей семейства адресов BGP.
Примечание
Этот плагин входит в коллекцию cisco.nxos (версия 1.4.0).
Для его установки используйте: ansible-galaxy collection install cisco.nxos
Чтобы использовать его в playbook, укажите: cisco.nxos.nxos_bgp_neighbor_af
Новое в версии 1.0.0: of cisco.nxos
Описание
- Управляет конфигурациями соседей семейства адресов BGP на коммутаторах NX-OS.
Примечание
У этого модуля есть соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| additional_paths_receive строка |
| Допустимые значения: enable для включения базовой команды; disable для отключения команды на уровне соседа AF (добавляет ключевое слово disable к базовой команде); и inherit для удаления команды на этом уровне (значение команды наследуется с более высокого уровня BGP). | |
| additional_paths_send строка |
| Допустимые значения: enable для включения базовой команды; disable для отключения команды на уровне соседа AF (добавляет ключевое слово disable к базовой команде); и inherit для удаления команды на этом уровне (значение команды наследуется с более высокого уровня BGP). | |
| advertise_map_exist список / элементы=строка | Условное объявление маршрута. Это свойство требует двух карт маршрутизации: advertise-map и exist-map. Допустимые значения — массив, определяющий имена обеих карт (advertise-map и exist-map), или просто 'default', например ['my_advertise_map', 'my_exist_map']. Эта команда взаимоисключающая с свойством advertise_map_non_exist. | ||
| advertise_map_non_exist список / элементы=строка | Условное объявление маршрута. Это свойство требует двух карт маршрутизации: advertise-map и non-exist-map. Допустимые значения — массив, определяющий имена обеих карт (advertise-map и non-exist-map), или просто 'default', например ['my_advertise_map', 'my_non_exist_map']. Эта команда взаимоисключающая с свойством advertise_map_exist. | ||
| afi строка / обязательно |
| Идентификатор семейства адресов. | |
| allowas_in булево |
| Активировать свойство allowas-in | |
| allowas_in_max строка | Значение max-occurrences для allowas_in. Допустимые значения — целое число или 'default'. Взаимоисключающее с allowas_in. | ||
| as_override булево |
| Активировать функцию as-override. | |
| asn строка / обязательно | Номер автономной системы BGP. Допустимые значения — строка, целое число в ASPLAIN или ASDOT формате. | ||
| default_originate булево |
| Активировать функцию default-originate. | |
| default_originate_route_map строка | Карта маршрутизации для свойства default_originate. Допустимые значения — строка, определяющая имя карты маршрутизации, или 'default'. Взаимоисключающее с default_originate. | ||
| disable_peer_as_check булево |
| Отключить проверку номера AS-соседа при объявлении. | |
| filter_list_in строка | Допустимые значения — строка, определяющая имя списка фильтров, или 'default'. | ||
| filter_list_out строка | Допустимые значения — строка, определяющая имя списка фильтров, или 'default'. | ||
| max_prefix_interval строка | Необязательный интервал перезапуска. Допустимые значения — целое число. Требует max_prefix_limit. Не может быть объединен с max_prefix_warning. | ||
| max_prefix_limit строка | Предельное значение максимального префикса. Допустимые значения — целое число или 'default'. | ||
| max_prefix_threshold строка | Необязательный процентный порог для генерации предупреждения. Допустимые значения — целое число. Требует max_prefix_limit. | ||
| max_prefix_warning булево |
| Необязательное ключевое слово только для предупреждений. Требует max_prefix_limit. Не может быть объединен с max_prefix_interval. | |
| neighbor строка / обязательно | Идентификатор соседа. Допустимые значения — строка. Соседи могут использовать IPv4 или IPv6 обозначения с или без длины префикса. | ||
| next_hop_self булево |
| Активировать функцию next-hop-self. | |
| next_hop_third_party булево |
| Активировать функцию next-hop-third-party. | |
| prefix_list_in строка | Допустимые значения — строка, определяющая имя списка префиксов, или 'default'. | ||
| prefix_list_out строка | Допустимые значения — строка, определяющая имя списка префиксов, или 'default'. | ||
| provider словарь | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Начиная с Ansible 2.6, рекомендуется использовать connection: httpapi для NX-API.Этот параметр будет удален в релизе после 2022-06-01. Для получения дополнительной информации см. руководство 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 строка |
| Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент 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, это значение игнорируется. | |
| rewrite_evpn_rt_asn boolean добавлен в 1.1.0 cisco.nxos |
| Автоматическое создание целевых маршрутов для соседа EBGP. | |
| route_map_in string | Допустимые значения — строка, определяющая имя карты маршрутизации, или 'default'. | ||
| route_map_out string | Допустимые значения — строка, определяющая имя карты маршрутизации, или 'default'. | ||
| route_reflector_client boolean |
| Клиент отражателя маршрутов. | |
| safi string / обязательно |
| Идентификатор подсемейства адресов. | |
| send_community string |
| Атрибут send-community. | |
| soft_reconfiguration_in string |
| Допустимые значения — 'включить' для включения базовой команды; 'всегда' для добавления ключевого слова always к базовой команде; и 'унаследовать' для удаления команды на данном уровне (значение команды наследуется с более высокого уровня BGP). | |
| soo string | Место происхождения. Допустимые значения — строка, определяющая внешнее сообщество VPN, или 'default'. | ||
| state string |
| Определяет, должен ли конфигурационный параметр присутствовать на устройстве. | |
| suppress_inactive boolean |
| Функция suppress-inactive. | |
| unsuppress_map string | unsuppress-map. Допустимые значения — строка, определяющая имя карты маршрутизации, или 'default'. | ||
| vrf string | По умолчанию: "default" | Имя VRF. Имя 'default' — допустимый VRF, представляющий глобальный bgp. | |
| weight string | Значение веса. Допустимые значения — целое число или 'default'. | ||
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
-
state=absentудаляет всю конфигурацию соседа BGP адресной семьи. - По умолчанию, если поддерживается, удаляются свойства
- Для сброса конфигурации максимального префикса требуется только %%%CODE_BLOCK_16%%.
- Сведения об использовании CLI и NX-API см. в руководстве NXOS Platform Options
- Более подробную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Более подробную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco .
Примеры
- name: configure RR client
cisco.nxos.nxos_bgp_neighbor_af:
asn: 65535
neighbor: 192.0.2.3
afi: ipv4
safi: unicast
route_reflector_client: true
state: present
rewrite_evpn_rt_asn: true
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список / элементы=строка | всегда | Команды, отправленные устройству Пример: ['router bgp 65535', 'neighbor 192.0.2.3', 'address-family ipv4 unicast', 'route-reflector-client', 'rewrite-evpn-rt-asn'] |
Авторы
- 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_neighbor_af_module.html
