nxos_bgp_neighbor_af - Управляет конфигурацией соседей BGP семейства адресов.
Новая версия 2.2.
Описание
- Управляет конфигурациями соседей 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. Допустимые значения — массив, содержащий имена обеих карт, или просто 'default', например ['my_advertise_map', 'my_exist_map']. Эта команда взаимоисключает свойство advertise_map_non_exist. | ||
| advertise_map_non_exist | Условное объявление маршрута. Это свойство требует две маршрутные карты: 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 bool |
| Активировать функцию as-override. | |
| asn обязательно | Номер автономной системы BGP. Допустимые значения: строка, целое число в ASPLAIN или ASDOT формате. | ||
| default_originate bool |
| Активировать функцию default-originate. | |
| default_originate_route_map | Маршрутная карта для свойства default_originate. Допустимые значения — строка, определяющая имя маршрутной карты, или 'default'. Взаимоисключающее свойство с default_originate. | ||
| disable_peer_as_check bool (добавлен в 2.5) |
| Отключить проверку номера 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 bool |
| Необязательное ключевое слово только для предупреждения. Требуется max_prefix_limit. Нельзя комбинировать с max_prefix_interval. | |
| neighbor обязательно | Идентификатор соседа. Допустимые значения — строка. Соседи могут использовать IPv4 или IPv6 запись с или без длины префикса. | ||
| next_hop_self bool |
| Активировать функцию next-hop-self. | |
| next_hop_third_party bool |
| Активировать функцию next-hop-third-party. | |
| prefix_list_in | Допустимые значения — строка, определяющая имя списка префиксов, или 'default'. | ||
| prefix_list_out | Допустимые значения — строка, определяющая имя списка префиксов, или 'default'. | ||
| provider | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр необходим только если используется NX-API. Для получения дополнительной информации, см. руководство NXOS Platform Options. Объект типа dict, содержащий данные подключения. | ||
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется как адрес назначения для транспорта. | ||
| port | По умолчанию: "0 (использовать общий порт)" | Указывает порт для использования при построении соединения с удаленным устройством. Это значение применяется к cli или nxapi. Значение порта по умолчанию будет установлено на соответствующий общий порт транспорта, если он не указан в задаче (cli=22, http=80, https=443). | |
| username | Настройка имени пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации подключения к удаленному устройству. Это распространенный аргумент для транспортов cli или nxapi. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| authorize bool (добавлен в 2.5.3) |
| Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| auth_pass (добавлен в 2.5.3) | По умолчанию: "none" | Указывает пароль для входа в привилегированный режим на удаленном устройстве, если это необходимо. Если authorize ложно, то этот аргумент ничего не делает. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| timeout (добавлен в 2.3) | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку. NX-API может быть медленным при возвращении по длинным командам (sh mac, sh bgp и т. д.). | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| transport обязательно | По умолчанию: "cli" | Настраивает транспортное соединение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_ssl bool |
| Настраивает transport для использования SSL, если значение true только при transport=nxapi, в противном случае это значение игнорируется. | |
| validate_certs bool |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах под личным контролем, использующих самозаверенные сертификаты. Если аргумент transport не nxapi, это значение игнорируется. | |
| use_proxy bool (added in 2.5) |
| Если no, переменные окружения http_proxy и https_proxy будут проигнорированы. | |
| route_map_in | Допустимые значения — строка, определяющая имя карты маршрутизации, или «default». | ||
| route_map_out | Допустимые значения — строка, определяющая имя карты маршрутизации, или «default». | ||
| route_reflector_client bool |
| Клиент отражателя маршрутизатора. | |
| safi required |
| Идентификатор подсемейства адресов. | |
| send_community |
| Атрибут send-community. | |
| soft_reconfiguration_in |
| Допустимые значения: «enable» для включения базовой команды; «always», чтобы добавить ключевое слово «always» к базовой команде; и «inherit», чтобы удалить команду на данном уровне (значение команды наследуется с более высокого уровня BGP). | |
| soo | Место происхождения. Допустимые значения — строка, определяющая расширенное сообщество VPN или «default». | ||
| state |
| Определяет, должен ли конфигурационный блок присутствовать на устройстве или нет. | |
| suppress_inactive bool |
| Функция suppress-inactive. | |
| unsuppress_map | unsuppress-map. Допустимые значения — строка, определяющая имя карты маршрутизации, или «default». | ||
| vrf | Значение по умолчанию: "default" | Имя VRF. Имя «default» является допустимым VRF, представляющим глобальный bgp. | |
| weight | Значение веса. Допустимые значения — целое число или «default». | ||
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
-
state=absentудаляет всю конфигурацию соседа BGP адресной семьи. - По умолчанию, если поддерживается, удаляет свойства.
- Для настройки по умолчанию максимального количества префиксов достаточно только
max_prefix_limit=default. - Для получения информации об использовании CLI и NX-API см. Руководство по параметрам платформы NXOS
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сетям Ansible
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.
Примеры
- name: configure RR client
nxos_bgp_neighbor_af:
asn: 65535
neighbor: '3.3.3.3'
afi: ipv4
safi: unicast
route_reflector_client: true
state: present
Возвращаемые значения
Общие возвращаемые значения описаны в этом разделе. Следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список | всегда | Команды, отправленные устройству Пример: ['router bgp 65535', 'neighbor 3.3.3.3', 'address-family ipv4 unicast', 'route-reflector-client'] |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как сетевой, что означает, что он обслуживается командой Ansible по работе с сетями. Подробнее см. в разделе по техническому обслуживанию модулей и поддержке.
Список других модулей, которые также обслуживает команда Ansible по работе с сетями, см. здесь.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в этой статье базы знаний
Автор
- 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.6/modules/nxos_bgp_neighbor_af_module.html