cisco.nxos.nxos_bgp_neighbor – Управляет конфигурациями соседей BGP.
Примечание
Этот плагин входит в коллекцию cisco.nxos (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install cisco.nxos.
Для использования в плейбуке укажите: cisco.nxos.nxos_bgp_neighbor.
Новое в версии 1.0.0: cisco.nxos
Описание
- Управляет конфигурациями соседей 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 |
| Указание типа соседа для сессии 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 строка |
| Настройка транспорта для подключения к удалённому устройству. Параметр 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». | |
| remote_as строка | Указание номера автономной системы соседа. Допустимые значения — строка или целое число в обозначениях ASPLAIN или ASDOT, или «default», что означает, что это свойство не будет настроено. | ||
| remove_private_as строка |
| Указание конфигурации для удаления частного номера AS из исходящих обновлений. Допустимые значения — «включить» для включения этой конфигурации, «выключить» для отключения, «все» для удаления всех частных номеров AS, или «заменить-as» для замены частного номера AS. | |
| shutdown логическое значение |
| Настройка административного отключения этого соседа. | |
| state строка |
| Определяет, должно ли быть конфигурационное значение присутствовать на устройстве. | |
| suppress_4_byte_as логическое значение |
| Настройка подавления функции 4-байтовой AS. | |
| timers_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 https://www.ansible.com/integrations/networks/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'] |
Авторы
- 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.10/collections/cisco/nxos/nxos_bgp_neighbor_module.html
