nxos_bgp_neighbor - Управляет конфигурациями соседей BGP.
Новая в версии 2.2.
Описание
- Управляет конфигурациями соседей BGP на коммутаторах NX-OS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| asn обязательно | Номер автономной системы BGP. Допустимые значения — строка, целое число в ASPLAIN или ASDOT формате. | ||
| capability_negotiation |
Нет | Настройка возможности переговоров о функциональных возможностях с этим соседом. | |
| connected_check |
Нет | Настройка проверки непосредственно подключенного узла. | |
| description | Значение по умолчанию: Нет | Описание соседа. | |
| dynamic_capability |
Нет | Настройка включения динамических возможностей. | |
| ebgp_multihop | Значение по умолчанию: Нет | Указывает значение TTL для многохопового удалённого узла. Допустимые значения — целые числа от 2 до 255, или ключевое слово 'default' для отключения этого свойства. | |
| local_as | Значение по умолчанию: Нет | Указывает номер локальной AS для соседа eBGP. Допустимые значения — строка или целое число в ASPLAIN или ASDOT формате, или 'default', что означает, что не нужно его настраивать. | |
| log_neighbor_changes |
Нет | Указывает, следует ли включать сообщения журнала для событий подключения/отключения соседа. | |
| low_memory_exempt |
Нет | Указывает, нужно ли отключать этого соседа при нехватке памяти. | |
| maximum_peers | Значение по умолчанию: Нет | Указывает максимальное количество узлов для этого соседа префикса. Допустимые значения — от 1 до 1000, или 'default', что не накладывает ограничений. Обратите внимание, что этот параметр принимается только для соседей с адресом/префиксом. | |
| neighbor обязательно | Идентификатор соседа. Допустимые значения — строка. Соседи могут использовать IPv4 или IPv6 обозначения с или без длины префикса. | ||
| provider | Значение по умолчанию: Нет | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр нужен только при использовании NX-API. Для получения дополнительной информации см. руководство по параметрам платформы NXOS Руководство по платформе NXOS. Объект словаря, содержащий данные подключения. | |
| username | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в командную строку или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задании, вместо него будет использовано значение переменной среды ANSIBLE_NET_USERNAME. | ||
| authorize (добавлен в 2.5.3) |
| Инструктирует модуль перейти в привилегированный режим на удалённом устройстве перед отправкой каких-либо команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задании, вместо него будет использовано значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задании, вместо него будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| use_proxy (добавлен в 2.5) |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| auth_pass (добавлен в 2.5.3) | Значение по умолчанию: нет | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задании, вместо него будет использовано значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| timeout (добавлен в 2.3) | Значение по умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку. NX-API может быть медленным при выполнении длительных команд (sh mac, sh bgp и т. д.). | |
| use_ssl |
| Настраивает транспорт на использование SSL, если значение true только когда transport=nxapi, в противном случае это значение игнорируется. | |
| password | Значение по умолчанию: Нет | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для cli или nxapi транспорта. Если значение не указано в задании, вместо него будет использовано значение переменной среды ANSIBLE_NET_PASSWORD. | |
| validate_certs |
Нет | Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах под собственным контролем, использующих самозаверяемые сертификаты. Если аргумент транспорта не nxapi, это значение игнорируется. | |
| port | Значение по умолчанию: 0 (используется общий порт) | Указывает порт для подключения к удалённому устройству. Это значение применяется к cli или nxapi. Значение порта по умолчанию будет соответствовать общему порту транспорта, если он не предоставлен в задании. (cli=22, http=80, https=443). | |
| transport обязательно | Значение по умолчанию: cli | Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент транспорта поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| pwd | Значение по умолчанию: Нет | Укажите пароль для соседа. Допустимое значение — строка. | |
| pwd_type |
Нет | Указывает тип шифрования, который будет использовать пароль. Допустимые значения — шифрование '3des' или 'cisco_type_7', или ключевое слово 'default'. | |
| remote_as | Значение по умолчанию: Нет | Указывает номер автономной системы соседа. Допустимые значения — строка или целое число в ASPLAIN или ASDOT формате, или 'default', что означает, что не нужно его настраивать. | |
| remove_private_as |
Нет | Указывает конфигурацию для удаления частного номера AS из исходящих обновлений. Допустимые значения — 'включить' для включения этой конфигурации, 'выключить' для выключения, 'все' для удаления всех частных номеров AS или 'заменить-as' для замены частного номера AS. | |
| shutdown |
Нет | Настройка административного отключения этого соседа. | |
| state |
| Определяет, должна ли конфигурация присутствовать на устройстве или нет. | |
| suppress_4_byte_as |
Нет | Настройка подавления возможности 4-байтового AS. | |
| timers_holdtime | Значение по умолчанию: Нет | Указывает значение таймера holdtime. Допустимые значения — целые числа от 0 до 3600 в секундах или 'default', что равно 180. | |
| timers_keepalive | Значение по умолчанию: Нет | Указывает значение таймера keepalive. Допустимые значения — целые числа от 0 до 3600 в секундах или 'default', что равно 60. | |
| transport_passive_only |
None | Указывает, следует ли разрешать только пассивное подключение. Допустимые значения 'true', 'false' и 'default', по умолчанию 'false'. Данный параметр может быть настроен только в случае, если сосед задан в формате IP-адреса без длины префикса. | |
| update_source | По умолчанию: None | Указывает интерфейс источника сессии BGP и обновлений. | |
| vrf | По умолчанию: default | Имя VRF. Имя 'default' является допустимым VRF, представляющим глобальный bgp. | |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
-
state=absentудаляет всю конфигурацию соседа BGP. - По умолчанию, где поддерживается, восстанавливает значения параметров по умолчанию.
- Дополнительная информация по использованию CLI и NX-API находится в руководстве NXOS Platform Options
- Дополнительная информация по использованию Ansible для управления сетевыми устройствами находится в руководстве Ansible Network Guide
- Дополнительная информация по использованию Ansible для управления устройствами Cisco находится на странице интеграции Cisco Cisco integration page.
Примеры
# create a new neighbor
- nxos_bgp_neighbor:
asn: 65535
neighbor: 3.3.3.3
local_as: 20
remote_as: 30
description: "just a description"
update_source: Ethernet1/3
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие — это поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список | всегда | Команды, отправленные на устройство Пример: ['router bgp 65535', 'neighbor 3.3.3.3', 'remote-as 30', 'update-source Ethernet1/3', 'description just a description', 'local-as 20'] |
Статус
Этот модуль помечен как превью, что означает, что интерфейс не гарантирует обратной совместимости.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в этой статье из базы знаний Knowledge Base article
Автор
- 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.5/modules/nxos_bgp_neighbor_module.html
