cisco.nxos.nxos_bgp_neighbor – (deprecated, removed after 2023-01-27) Управляет конфигурациями соседей BGP.

Примечание

Этот плагин входит в коллекцию cisco.nxos (версия 1.4.0).

Для его установки используйте: ansible-galaxy collection install cisco.nxos

Для использования в книге задач, укажите: cisco.nxos.nxos_bgp_neighbor

Введено в версии 1.0.0: cisco.nxos

УСТЕРЕШЕНО
Описание
Параметры
Примечания
Примеры
Значения возврата
Статус

УСТЕРЕШЕНО

Удалино в: главной версии после 2023-01-27
Почему: Выпущен обновленный модуль с большей функциональностью.
Альтернатива: nxos_bgp_global

Описание

Управляет конфигурациями соседей BGP на коммутаторах NX-OS.

Примечание

У этого модуля есть соответствующий плагин действий.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
asn строка / обязательно			Номер автономной системы BGP. Допустимые значения — строка, целое число в ASPLAIN или ASDOT формате.
bfd строка		Варианты: включить выключить	Включает/выключает BFD для заданного соседа. Зависимость: ''функция bfd''
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 обозначение, с или без длины префикса.
peer_type строка добавлено в 1.1.0 cisco.nxos		Варианты: fabric_border_leaf fabric_external выключить	Указывает тип соседа для сессии BGP.
provider словарь			Устарело Начиная с Ansible 2.5 рекомендуется использовать `connection: network_cli`. Начиная с Ansible 2.6 рекомендуется использовать `connection: httpapi` для NX-API. Этот параметр будет удален в релизе после 2022-06-01. Дополнительную информацию можно найти в руководстве NXOS Platform Options. Объект словаря, содержащий детали подключения.
	auth_pass строка		Указывает пароль для входа в привилегированный режим на удаленном устройстве, если это необходимо. Если authorize равно false, то этот аргумент ничего не делает. Если значение не указано в задаче, будет использовано значение переменной окружения `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 строка	Варианты: cli ← nxapi	Настраивает транспортное соединение для подключения к удаленному устройству. Аргумент 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 логическое значение	Варианты: нет ← да	Если `no`, сертификаты SSL не будут проверены. Это должно использоваться только на контролируемых вами сайтах с самозаверяющимися сертификатами. Если аргумент transport не nxapi, это значение игнорируется.
pwd строка			Указывает пароль для соседа. Допустимое значение — строка.
pwd_type строка		Варианты: 3des cisco_type_7 default	Указывает тип шифрования, который будет использоваться для пароля. Допустимые значения — шифрование '3des' или 'cisco_type_7', или ключевое слово 'default'.
remote_as строка			Указывает номер автономной системы соседа. Допустимые значения — строка или целое число в ASPLAIN или ASDOT формате, или 'default', что означает отсутствие настройки.
remove_private_as строка		Варианты: включить выключить все заменить-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 логическое значение		Варианты: нет да	Указывает, нужно ли допускать только пассивное подключение. Допустимые значения — 'true', 'false' и 'default', что по умолчанию равно 'false'. Это свойство можно настроить только тогда, когда сосед имеет формат адреса 'ip' без длины префикса.

update_source string			Укажите интерфейс источника сессии BGP и обновлений.
vrf string		По умолчанию: "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
- cisco.nxos.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
    peer_type: fabric_external

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Возвращаемое значение	Описание
commands list / elements=string	всегда	Команды, отправленные на устройство Пример: ['router bgp 65535', 'neighbor 192.0.2.3', 'remote-as 30', 'update-source Ethernet1/3', 'description just a description', 'local-as 20', 'peer-type fabric-external']

Статус

Этот модуль будет удалён в основной версии после 2023-01-27. [устарел]
Дополнительную информацию см. в разделе УСТАРЕЛО.

Авторы

Gabriele Gerbino (@GGabriele)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/nxos/nxos_bgp_neighbor_module.html