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