nxos_bgp_neighbor_af - Управляет конфигурацией соседей BGP адресной семьи.
Новая в версии 2.2.
Краткое описание
- Управляет конфигурацией соседей BGP адресной семьи на коммутаторах NX-OS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| additional_paths_receive |
None | Допустимые значения: enable для включения базовой команды; disable для отключения команды на уровне соседа AF (добавляет ключевое слово disable к базовой команде); и inherit для удаления команды на этом уровне (значение команды наследуется с более высокого уровня BGP). | |
| additional_paths_send |
None | Допустимые значения: enable для включения базовой команды; disable для отключения команды на уровне соседа AF (добавляет ключевое слово disable к базовой команде); и inherit для удаления команды на этом уровне (значение команды наследуется с более высокого уровня BGP). | |
| advertise_map_exist | Значение по умолчанию: None | Условное объявление маршрута. Этот параметр требует двух карт маршрутизации: advertise-map и exist-map. Допустимые значения — массив, содержащий имена обеих карт (например, ['my_advertise_map', 'my_exist_map']), или просто 'default'. Эта команда взаимоисключающая с параметром advertise_map_non_exist. | |
| advertise_map_non_exist | Значение по умолчанию: None | Условное объявление маршрута. Этот параметр требует двух карт маршрутизации: advertise-map и non-exist-map. Допустимые значения — массив, содержащий имена обеих карт (например, ['my_advertise_map', 'my_non_exist_map']), или просто 'default'. Эта команда взаимоисключающая с параметром advertise_map_exist. | |
| afi обязательно |
| Идентификатор семейства адресов. | |
| allowas_in | Значение по умолчанию: None | Активировать свойство allowas-in | |
| allowas_in_max | Значение по умолчанию: None | Максимальное количество для allowas_in. Допустимые значения — целое число или 'default'. Взаимоисключающее с allowas_in. | |
| as_override |
None | Активировать функцию as-override. | |
| asn обязательно | Номер автономной системы BGP. Допустимые значения — строка, целое число в ASPLAIN или ASDOT формате. | ||
| default_originate |
None | Активировать функцию default-originate. | |
| default_originate_route_map | Значение по умолчанию: None | Карта маршрутизации для свойства default_originate. Допустимые значения — строка, определяющая имя карты маршрутизации, или 'default'. Взаимоисключающее с default_originate. | |
| disable_peer_as_check (добавлено в 2.5) |
| Отключить проверку номера AS-соседа при объявлении | |
| filter_list_in | Значение по умолчанию: None | Допустимые значения — строка, определяющая имя списка фильтров, или 'default'. | |
| filter_list_out | Значение по умолчанию: None | Допустимые значения — строка, определяющая имя списка фильтров, или 'default'. | |
| max_prefix_interval | Значение по умолчанию: None | Дополнительный интервал перезапуска. Допустимые значения — целое число. Требуется max_prefix_limit. Нельзя использовать совместно с max_prefix_warning. | |
| max_prefix_limit | Значение по умолчанию: None | Максимальное значение предела префиксов. Допустимые значения — целое число или 'default'. | |
| max_prefix_threshold | Значение по умолчанию: None | Дополнительный порог в процентах, при котором генерируется предупреждение. Допустимые значения — целое число. Требуется max_prefix_limit. | |
| max_prefix_warning |
None | Дополнительное ключевое слово предупреждения. Требуется max_prefix_limit. Нельзя использовать совместно с max_prefix_interval. | |
| neighbor обязательно | Идентификатор соседа. Допустимые значения — строка. Соседи могут использовать IPv4 или IPv6 обозначение с или без длины префикса. | ||
| next_hop_self |
None | Активировать функцию next-hop-self. | |
| next_hop_third_party |
None | Активировать функцию next-hop-third-party. | |
| prefix_list_in | Значение по умолчанию: None | Допустимые значения — строка, определяющая имя списка префиксов, или 'default'. | |
| prefix_list_out | Значение по умолчанию: None | Допустимые значения — строка, определяющая имя списка префиксов, или 'default'. | |
| provider | Значение по умолчанию: None | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр требуется только при использовании NX-API. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект словаря, содержащий данные подключения. | |
| username | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| authorize (добавлено в 2.5.3) |
| Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот параметр используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| use_proxy (добавлено в 2.5) |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| auth_pass (добавлено в 2.5.3) | Значение по умолчанию: none | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize равно false, этот параметр ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве целевого адреса для транспорта. | ||
| timeout (добавлено в 2.3) | Значение по умолчанию: 10 | Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т.д.). | |
| use_ssl |
| Настраивает транспорт на использование SSL, если значение true, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| password | Значение по умолчанию: None | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий параметр, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | |
| validate_certs |
None | Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах под собственным контролем с использованием самозаверенных сертификатов. Если параметр транспорт не nxapi, это значение игнорируется. | |
| port | Значение по умолчанию: 0 (использовать стандартный порт) | Указывает порт, который используется при установлении подключения к удалённому устройству. Это значение применяется как для cli, так и для nxapi. Значение порта по умолчанию соответствует соответствующему стандартному порту транспорта, если он не указан в задаче. (cli=22, http=80, https=443). | |
| transport обязательно | Значение по умолчанию: cli | Настраивает транспортное соединение, которое используется при подключении к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| route_map_in | Значение по умолчанию: None | Допустимые значения — строка, определяющая имя маршрутной карты, или «default». | |
| route_map_out | Значение по умолчанию: None | Допустимые значения — строка, определяющая имя маршрутной карты, или «default». | |
| route_reflector_client |
None | Клиент отражателя маршрутизатора. | |
| safi обязательно |
| Идентификатор подсемейства адресов. | |
| send_community |
None | Атрибут send-community. | |
| soft_reconfiguration_in |
None | Допустимые значения — «enable» для базовой команды включения; «always», чтобы добавить ключевое слово «always» к базовой команде; и «inherit», чтобы удалить команду на этом уровне (значение команды наследуется из более высокого уровня BGP). | |
| soo | Значение по умолчанию: None | Местоположение источника. Допустимые значения — строка, определяющая внешнее сообщество VPN, или «default». | |
| state |
| Определяет, должно ли конфигурация присутствовать на устройстве или нет. | |
| suppress_inactive |
None | Функция suppress-inactive. | |
| unsuppress_map | Значение по умолчанию: None | unsuppress-map. Допустимые значения — строка, определяющая имя маршрутной карты, или «default». | |
| vrf | Значение по умолчанию: default | Имя VRF. Имя «default» является допустимым VRF, представляющим глобальный bgp. | |
| weight | Значение по умолчанию: None | Значение веса. Допустимые значения — целое число или «default». | |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
-
state=absentудаляет всю конфигурацию соседа семейства адресов BGP. - Значение по умолчанию, если поддерживается, удаляет свойства
- Для настройки значения по умолчанию для максимальной конфигурации префикса необходимо только
max_prefix_limit=default. - Дополнительную информацию об использовании CLI и NX-API см. в руководстве NXOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.
Примеры
- name: configure RR client
nxos_bgp_neighbor_af:
asn: 65535
neighbor: '3.3.3.3'
afi: ipv4
safi: unicast
route_reflector_client: true
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращённое значение | Описание |
|---|---|---|
| commands список | всегда | команды, отправленные на устройство Пример: ['router bgp 65535', 'neighbor 3.3.3.3', 'address-family ipv4 unicast', 'route-reflector-client'] |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Поддержка
Дополнительную информацию о поддержке этого модуля 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.5/modules/nxos_bgp_neighbor_af_module.html
