cisco.nxos.nxos_bgp_neighbor_af – Управляет конфигурацией соседей BGP адресной семьи.
Примечание
Этот плагин является частью коллекции cisco.nxos (версии 1.3.1).
Для его установки используйте: ansible-galaxy collection install cisco.nxos
Для использования в плейбуке укажите: 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 строка | Предельное значение max-prefix. Допустимые значения — целое число или '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, для NX-API рекомендуется использовать connection: httpapi. Этот параметр будет удален в релизе после 2022-06-01. Для получения дополнительной информации, обратитесь к руководству NXOS Platform Options. Объект словаря, содержащий данные подключения. | ||
| 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, это значение игнорируется. | |
| 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 |
| Допустимые значения: «включить» для включения базовой команды; «всегда», чтобы добавить ключевое слово «всегда» к базовой команде; и «унаследовать», чтобы удалить команду на этом уровне (значение команды наследуется из более высокого уровня BGP). | |
| soo string | Место происхождения. Допустимые значения — строка, определяющая VPN extcommunity, или «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 адресной семьи. - По умолчанию, если поддерживается, удаляет свойства
- Для настройки максимального префикса по умолчанию необходимо только
max_prefix_limit=default. - Дополнительную информацию об использовании CLI и NX-API см. в руководстве NXOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco https://www.ansible.com/integrations/networks/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 список / элементы=строка | всегда | команды, отправленные на устройство Пример: ['маршрутизатор bgp 65535', 'сосед 192.0.2.3', 'семейство адресов ipv4 unicast', 'route-reflector-client', 'rewrite-evpn-rt-asn'] |
Авторы
- 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_neighbor_af_module.html
