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 -			Укажите номер local-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 Platform Options. Объект словаря, содержащий сведения о подключении.
	auth_pass - добавлено в 2.5.3	Значение по умолчанию: "none"	Указывает пароль, используемый для входа в привилегированный режим на удалённом устройстве. Если authorize равно false, то этот аргумент ничего не делает. Если значение не указано в задании, используется значение переменной окружения `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 - добавлено в 2.3	Значение по умолчанию: 10	Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. NX-API может медленно реагировать при длительных командах (sh mac, sh bgp и т.д.).
	transport - / обязательно	Значение по умолчанию: "cli"	Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi.
	use_proxy логическое добавлено в 2.5	Варианты: нет да ←	Если `no`, переменные окружения `http_proxy` и `https_proxy` будут проигнорированы.
	use_ssl логическое	Варианты: нет ← да	Настраивает transport для использования SSL, если значение равно true, только если `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 boolean	Варианты: no yes	Настройка для административного отключения этого соседа.
state -	Варианты: present ← absent	Определяет, должно ли конфигурация присутствовать на устройстве или нет.
suppress_4_byte_as boolean	Варианты: no yes	Настройка для подавления возможности 4-байтового AS.
timers_holdtime -		Укажите значение таймера holdtime. Допустимые значения — целые числа от 0 до 3600 в секундах или «default», что соответствует 180.
timers_keepalive -		Укажите значение таймера keepalive. Допустимые значения — целые числа от 0 до 3600 в секундах или «default», что соответствует 60.
transport_passive_only boolean	Варианты: no yes	Укажите, разрешать ли только пассивное подключение. Допустимые значения — '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
    description: "just a description"
    update_source: Ethernet1/3
    state: present

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

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

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

Статус

Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается командой Ansible Network. [сеть]

Поддержка Red Hat

Дополнительную информацию о поддержке данного модуля Red Hat см. в этой статье базы знаний Red Hat Knowledge Base.

Авторы

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.7/modules/nxos_bgp_neighbor_module.html