nxos_bgp_neighbor – Управляет конфигурациями соседей BGP

Новая в версии 2.2.

Описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
asn - / обязательно			Номер автономной системы BGP. Допустимые значения: строка, целое число в формате ASPLAIN или ASDOT.
capability_negotiation boolean		Варианты: no yes	Настройка переговоров о поддержке функций с этим соседом.
connected_check boolean		Варианты: no yes	Настройка проверки наличия прямого подключения к соседу.
description -			Описание соседа.
dynamic_capability boolean		Варианты: no yes	Настройка динамической поддержки функций.
ebgp_multihop -			Указание TTL для многохопового удаленного соседа. Допустимые значения: целые числа от 2 до 255, или ключевое слово 'default' для отключения этой опции.
local_as -			Указание номера локальной AS для соседа eBGP. Допустимые значения: строка или целое число в формате ASPLAIN или ASDOT, или 'default', что означает отсутствие настройки.
log_neighbor_changes -		Варианты: enable disable inherit	Указание, нужно ли регистрировать события изменения статуса соседа.
low_memory_exempt boolean		Варианты: no yes	Указание, нужно ли отключить соседа при низком уровне памяти.
maximum_peers -			Указание максимального количества соседей для этого префикса. Допустимые значения от 1 до 1000, или 'default' для отсутствия ограничения. Этот параметр принимается только для соседей с адресом/префиксом.
neighbor - / обязательно			Идентификатор соседа. Допустимые значения: строка. Соседи могут использовать IPv4 или IPv6 обозначение, с или без длины префикса.
provider dictionary			Устарело Начиная с Ansible 2.5 рекомендуется использовать `connection: network_cli`. Этот параметр требуется только при использовании NX-API. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект dict, содержащий данные подключения.
	auth_pass строка добавлено в 2.5.3		Указывает пароль, необходимый для входа в привилегированный режим на удаленном устройстве. Если authorize равно false, этот аргумент не имеет значения. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	authorize boolean добавлено в 2.5.3	Варианты: no ← yes	Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной окружения `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 ← nxapi	Настройка транспорта для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству по cli (ssh) или nxapi.
	use_proxy boolean добавлено в 2.5	Варианты: no yes ←	Если `no`, переменные окружения `http_proxy` и `https_proxy` будут проигнорированы.
	use_ssl boolean	Варианты: no ← yes	Настройка транспорта на использование SSL, если установлено `yes`, только когда `transport=nxapi`, в противном случае это значение игнорируется.
	username строка		Указывает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_USERNAME`.
	validate_certs boolean	Варианты: no yes ←	Если `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 -		Варианты: enable disable all replace-as	Укажите конфигурацию для удаления частного номера AS из исходящих обновлений. Допустимые значения: 'enable' для включения, 'disable' для выключения, 'all' для удаления всех частных номеров AS или 'replace-as' для замены частного номера AS.

shutdown boolean	Варианты: no yes	Настроить административное отключение этого соседа.
state -	Варианты: present ← absent	Определяет, должно ли конфигурирование присутствовать на устройстве или нет.
suppress_4_byte_as boolean	Варианты: no yes	Настроить подавление 4-байтовой возможности AS.
timers_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
Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. Руководство по сетям Ansible
Для получения дополнительной информации об использовании 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 по сетям. [сеть]

Поддержка 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.8/modules/nxos_bgp_neighbor_module.html