nxos_bgp_neighbor_af – Управляет конфигурацией соседей семейств адресов BGP.
Новая в версии 2.2.
Краткое описание
- Управляет конфигурацией соседей семейств адресов BGP на коммутаторах NX-OS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| additional_paths_receive - |
| Допустимые значения: enable для включения базовой команды; disable для отключения команды на уровне соседа AF (добавляется ключевое слово disable к базовой команде); и inherit для удаления команды на этом уровне (значение команды наследуется из более высокого уровня BGP). | |
| additional_paths_send - |
| Допустимые значения: enable для включения базовой команды; disable для отключения команды на уровне соседа AF (добавляется ключевое слово disable к базовой команде); и inherit для удаления команды на этом уровне (значение команды наследуется из более высокого уровня BGP). | |
| advertise_map_exist - | Условная реклама маршрутов. Данный параметр требует два маршрутных файла: advertise-map и exist-map. Допустимые значения: массив, содержащий имена advertise-map и exist-map, или просто 'default', например ['my_advertise_map', 'my_exist_map']. Эта команда взаимоисключающая с свойством advertise_map_non_exist. | ||
| advertise_map_non_exist - | Условная реклама маршрутов. Данный параметр требует два маршрутных файла: advertise-map и non-exist-map. Допустимые значения: массив, содержащий имена advertise-map и non-exist-map, или просто 'default', например ['my_advertise_map', 'my_non_exist_map']. Эта команда взаимоисключающая с свойством advertise_map_exist. | ||
| afi - / обязательно |
| Идентификатор семейства адресов. | |
| allowas_in - | Активировать свойство allowas-in | ||
| allowas_in_max - | Максимальное количество вхождений для allowas_in. Допустимые значения: целое число или 'default'. Взаимоисключающее с allowas_in. | ||
| as_override логическое |
| Активировать функцию as-override. | |
| asn - / обязательно | Номер автономной системы BGP. Допустимые значения: строка, целое число в обозначениях ASPLAIN или ASDOT. | ||
| default_originate логическое |
| Активировать функцию default-originate. | |
| default_originate_route_map - | Маршрутная карта для свойства default_originate. Допустимые значения: строка, определяющая имя маршрутной карты, или 'default'. Взаимоисключающее с default_originate. | ||
| disable_peer_as_check логическое добавлен в 2.5 |
| Отключить проверку номера AS соседа при рекламе. | |
| filter_list_in - | Допустимые значения: строка, определяющая имя списка фильтров, или 'default'. | ||
| filter_list_out - | Допустимые значения: строка, определяющая имя списка фильтров, или 'default'. | ||
| max_prefix_interval - | Необязательный интервал перезапуска. Допустимые значения: целое число. Требуется max_prefix_limit. Не может быть совмещено с max_prefix_warning. | ||
| max_prefix_limit - | Максимальное значение предела префиксов. Допустимые значения: целое число или 'default'. | ||
| max_prefix_threshold - | Необязательный процентный порог, при достижении которого генерируется предупреждение. Допустимые значения: целое число. Требуется max_prefix_limit. | ||
| max_prefix_warning логическое |
| Необязательное ключевое слово только для предупреждения. Требуется max_prefix_limit. Не может быть совмещено с max_prefix_interval. | |
| neighbor - / обязательно | Идентификатор соседа. Допустимые значения: строка. Соседи могут использовать IPv4 или IPv6 обозначения с или без длины префикса. | ||
| next_hop_self логическое |
| Активировать функцию next-hop-self. | |
| next_hop_third_party логическое |
| Активировать функцию next-hop-third-party. | |
| prefix_list_in - | Допустимые значения: строка, определяющая имя списка префиксов, или 'default'. | ||
| prefix_list_out - | Допустимые значения: строка, определяющая имя списка префиксов, или 'default'. | ||
| 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 - added in 2.3 | Default: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать данные при выполнении длительных команд (sh mac, sh bgp и т. д.). | |
| transport - / required | Default: "cli" | Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству по протоколам cli (ssh) или nxapi. | |
| use_proxy boolean added in 2.5 |
| Если no, переменные окружения http_proxy и https_proxy будут проигнорированы. | |
| use_ssl boolean |
| Настраивает transport на использование SSL, если установлено значение true, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username - | Настраивает имя пользователя для аутентификации соединения с удалённым устройством. Это значение используется для аутентификации входа по CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задании, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не будут проверяться. Это следует использовать только на контролируемых лично сайтах, использующих самозаверяющие сертификаты. Если аргумент transport не является nxapi, это значение игнорируется. | |
| route_map_in - | Допустимые значения — строка, определяющая имя карты маршрутизации, или «default». | ||
| route_map_out - | Допустимые значения — строка, определяющая имя карты маршрутизации, или «default». | ||
| route_reflector_client boolean |
| Клиент маршрутизатора-отражателя. | |
| safi - / required |
| Идентификатор подсемейства адресов. | |
| send_community - |
| Атрибут send-community. | |
| soft_reconfiguration_in - |
| Допустимые значения — «enable» для базового включения команды; «always», чтобы добавить ключевое слово always к базовой команде; и «inherit», чтобы удалить команду на этом уровне (значение команды наследуется с более высокого уровня BGP). | |
| soo - | Местоположение источника. Допустимые значения — строка, определяющая VPN extcommunity, или «default». | ||
| state - |
| Определяет, должен ли конфигурационный файл присутствовать на устройстве или нет. | |
| suppress_inactive boolean |
| Функция suppress-inactive. | |
| unsuppress_map - | unsuppress-map. Допустимые значения — строка, определяющая имя карты маршрутизации, или «default». | ||
| vrf - | Default: "default" | Имя VRF. Имя «default» — это допустимый VRF, представляющий глобальную bgp. | |
| weight - | Значение веса. Допустимые значения — целое число или «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 Cisco integration page.
Примеры
- name: configure RR client
nxos_bgp_neighbor_af:
asn: 65535
neighbor: '192.0.2.3'
afi: ipv4
safi: unicast
route_reflector_client: true
state: present
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращённое | Описание |
|---|---|---|
| commands list | всегда | Команды, отправленные устройству Пример: ['router bgp 65535', 'neighbor 192.0.2.3', 'address-family ipv4 unicast', 'route-reflector-client'] |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [preview]
- Этот модуль поддерживается Ansible Network Team. [network]
Поддержка Red Hat
Дополнительная информация о поддержке этого модуля Red Hat доступна в статье базы знаний Red Hat Red Hat Knowledge Base article.
Авторы
- 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_af_module.html
