nxos_bgp_neighbor — Управление конфигурацией соседей BGP.
Новое в версии 2.2.
Описание
- Управляет конфигурациями соседей BGP на коммутаторах NX-OS.
Параметры
| параметр | обязательный | значение по умолчанию | возможные значения | комментарии |
|---|---|---|---|---|
| asn | да | Номер автономной системы BGP. Допустимые значения — строка, целое число в ASPLAIN или ASDOT формате. | ||
| auth_pass (добавлен в 2.4.4)
| нет | отсутствует | Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize ложно, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| authorize (добавлен в 2.4.4)
| нет |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| capability_negotiation | нет |
| Настройка необходимости переговоров о поддержке возможностей с этим соседом. | |
| connected_check | нет |
| Настройка необходимости проверки прямого подключения к пиру. | |
| description | нет | Описание соседа. | ||
| dynamic_capability | нет |
| Настройка необходимости включения динамической поддержки возможностей. | |
| ebgp_multihop | нет | Указывает TTL для многохопового маршрута для удалённого пира. Допустимые значения — целые числа от 2 до 255 или ключевое слово 'default' для отключения этого свойства. | ||
| host | да | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется как адрес назначения для транспорта. | ||
| local_as | нет | Указывает номер локальной AS для соседа eBGP. Допустимые значения — строка или целое число в ASPLAIN или ASDOT формате, или 'default', что означает, что не нужно настраивать его. | ||
| log_neighbor_changes | нет |
| Указывает, нужно ли включать сообщения журналов для событий включения/выключения соседа. | |
| low_memory_exempt | нет |
| Указывает, нужно ли отключать этого соседа при низком объёме памяти. | |
| maximum_peers | нет | Указывает максимальное количество пиров для этого префикса соседа. Допустимые значения — от 1 до 1000 или 'default', что не накладывает ограничений. | ||
| neighbor | да | Идентификатор соседа. Допустимые значения — строка. Соседи могут использовать IPv4 или IPv6 нотацию, с или без длины префикса. | ||
| password | нет | Указывает пароль для аутентификации подключения к удалённому устройству. Этот аргумент обычно используется для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port | нет | 0 (используется общий порт) | Указывает порт для подключения к удалённому устройству. Это значение применяется к cli или nxapi. Значение порта по умолчанию соответствует общему порту транспорта, если он не указан в задаче (cli=22, http=80, https=443). | |
| provider | нет | Удобный метод, позволяющий передавать все аргументы nxos как объект словаря. Все ограничения (обязательность, допустимые значения и т. д.) должны быть удовлетворены либо отдельными аргументами, либо значениями в этом словаре. | ||
| pwd | нет | Укажите пароль для соседа. Допустимое значение — строка. | ||
| pwd_type | нет |
| Указывает тип шифрования, используемого паролем. Допустимые значения — '3des' или 'cisco_type_7'. | |
| remote_as | нет | Указывает номер автономной системы соседа. Допустимые значения — строка или целое число в ASPLAIN или ASDOT формате, или 'default', что означает, что не нужно настраивать его. | ||
| remove_private_as | нет |
| Указывает конфигурацию для удаления частного номера AS из исходящих обновлений. Допустимые значения — 'включено' для включения этой конфигурации, 'выключено' для выключения этой конфигурации, 'все' для удаления всех частных номеров AS или 'заменить-as' для замены частного номера AS. | |
| shutdown | нет |
| Настройка административного отключения этого соседа. | |
| ssh_keyfile | нет | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| state | нет | настоящее |
| Определяет, должна ли конфигурация присутствовать на устройстве. |
| suppress_4_byte_as | нет |
| Настройка для подавления 4-байтового параметра AS. | |
| timeout (добавлен в 2.3)
| нет | 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать данные при выполнении длительных команд (sh mac, sh bgp и т. д.). | |
| timers_holdtime | нет | Указывает значение таймера удержания. Допустимые значения — целые числа от 0 до 3600 в секундах или 'default', что равно 180. | ||
| timers_keepalive | нет | Указывает значение таймера keepalive. Допустимые значения — целые числа от 0 до 3600 в секундах или 'default', что равно 60. | ||
| transport | да | cli | Настраивает транспортное подключение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| transport_passive_only | нет |
| Указывает, нужно ли разрешать только пассивное подключение. Допустимые значения — 'true', 'false' и 'default', которое по умолчанию равно 'false'. Это свойство может настраиваться только при адресации соседа в формате 'ip' без длины префикса. Это свойство и свойство transport_passive_mode взаимно исключают друг друга. | |
| update_source | нет | Указывает интерфейс источника для сеанса BGP и обновлений. | ||
| use_ssl | нет |
| Настраивает transport для использования SSL, если значение установлено в true, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username | нет | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| validate_certs | нет |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах с самоподписанными сертификатами. Если аргумент transport не nxapi, это значение игнорируется. | |
| vrf | нет | default | Имя VRF. Имя 'default' — это допустимый VRF, представляющий глобальный bgp. |
Примеры
# 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 просто описание', 'local-as 20'] |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
-
state=absentудаляет всю конфигурацию соседа BGP. - Значение по умолчанию, где поддерживается, восстанавливает значение параметров по умолчанию.
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Информация о техническом обслуживании
Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в этом knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
Для помощи в разработке модулей, если вы так решите, пожалуйста, прочитайте Информацию о сообществе и участии, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/nxos_bgp_neighbor_module.html
