nxos_bgp_neighbor - Управляет конфигурациями соседей BGP.
Новая версия 2.2.
Краткое описание
- Управляет конфигурациями соседей BGP на коммутаторах NX-OS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| asn обязательно | Номер автономной системы BGP. Допустимые значения: строка, целое число в ASPLAIN или ASDOT формате. | ||
| capability_negotiation bool |
| Настроить, нужно ли согласовывать возможности с этим соседом. | |
| connected_check bool |
| Настроить проверку прямого подключения к соседу. | |
| description | Описание соседа. | ||
| dynamic_capability bool |
| Настроить включение динамических возможностей. | |
| ebgp_multihop | Указать TTL для многохоповой удаленной пары. Допустимые значения: целые числа от 2 до 255 или ключевое слово 'default' для отключения этого свойства. | ||
| local_as | Указать номер локальной AS для eBGP соседа. Допустимые значения: строка или целое число в ASPLAIN или ASDOT формате, или 'default', что означает, что не нужно его настраивать. | ||
| log_neighbor_changes |
| Указать, нужно ли включать сообщения журнала для событий подключения/отключения соседа. | |
| low_memory_exempt bool |
| Указать, нужно ли отключать этого соседа при низкой памяти. | |
| maximum_peers | Указать максимальное количество пар для данного префикса соседа. Допустимые значения: от 1 до 1000 или 'default', что не накладывает ограничение. Обратите внимание, что этот параметр принимается только для соседей с адресом/префиксом. | ||
| neighbor обязательно | Идентификатор соседа. Допустимые значения: строка. Соседи могут использовать IPv4 или IPv6 обозначения с или без длины префикса. | ||
| provider | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр необходим только при использовании NX-API. Для получения дополнительной информации, пожалуйста, обратитесь к руководству NXOS Platform Options. Объект словаря, содержащий данные подключения. | ||
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному протоколу. Значение host используется в качестве адреса назначения для протокола. | ||
| port | Значение по умолчанию: "0 (использовать стандартный порт)" | Указывает порт для использования при построении подключения к удаленному устройству. Это значение относится к cli или nxapi. Значение порта будет по умолчанию соответствовать общему порту соответствующего протокола, если не указано иное в задаче. (cli=22, http=80, https=443). | |
| username | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого протокола. Если значение не указано в задаче, будет использоваться значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации подключения к удаленному устройству. Этот параметр обычно используется для протоколов cli или nxapi. Если значение не указано в задаче, будет использоваться значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| authorize bool (добавлено в 2.5.3) |
| Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использоваться значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| auth_pass (добавлено в 2.5.3) | Значение по умолчанию: "none" | Указывает пароль для входа в привилегированный режим на удаленном устройстве, если это необходимо. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, будет использоваться значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| timeout (добавлено в 2.3) | Значение по умолчанию: 10 | Указывает тайм-аут в секундах для связи с сетевым устройством при подключении или отправке команд. Если тайм-аут истекает до завершения операции, модуль выдаст ошибку. NX-API может быть медленным при возврате на длительных командах (sh mac, sh bgp и т. д.). | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для протокола cli. Если значение не указано в задаче, будет использоваться значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| transport обязательно | Значение по умолчанию: "cli" | Настраивает протокол подключения при подключении к удаленному устройству. Аргумент transport поддерживает подключение к устройству по cli (ssh) или nxapi. | |
| use_ssl bool |
| Настраивает transport для использования SSL, если установлено в true, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| validate_certs bool |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых лично сайтах, использующих самозаверяющие сертификаты. Если аргумент transport не nxapi, это значение игнорируется. | |
| use_proxy bool (добавлено в 2.5) |
| Если no, переменные окружения http_proxy и https_proxy будут проигнорированы. | |
| 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 bool |
| Настройка для административного отключения этого соседа. | |
| state |
| Определяет, должна ли конфигурация присутствовать на устройстве или нет. | |
| suppress_4_byte_as bool |
| Настройка для подавления возможности 4-байтового AS. | |
| timers_holdtime | Указать значение таймера удержания. Допустимые значения: целые числа от 0 до 3600 в секундах или 'default', что равно 180. | ||
| timers_keepalive | Указать значение таймера keepalive. Допустимые значения: целые числа от 0 до 3600 в секундах или 'default', что равно 60. | ||
| transport_passive_only bool |
| Указывает, разрешить ли только пассивное подключение. Допустимые значения: '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: 3.3.3.3
local_as: 20
remote_as: 30
description: "just a description"
update_source: Ethernet1/3
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| commands список | всегда | Команды, отправленные устройству Пример: ['router bgp 65535', 'neighbor 3.3.3.3', 'remote-as 30', 'update-source Ethernet1/3', 'description just a description', 'local-as 20'] |
Статус
Этот модуль помечен как превью, что означает, что гарантия обратной совместимости не предоставляется.
Техническое обслуживание
Этот модуль помечен как сетевой, что означает, что он поддерживается командой Ansible Network Team. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, поддерживаемых командой Ansible Network Team, см. в здесь.
Поддержка
Дополнительную информацию о поддержке этого модуля 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.6/modules/nxos_bgp_neighbor_module.html
