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 | нет | Необязательное значение max-occurrences для allowas_in. Допустимые значения: целое число или 'default'. Может использоваться независимо или в сочетании с allowas_in. | ||
| as_override | нет |
| Активировать функцию as-override. | |
| asn | да | Номер автономной системы BGP. Допустимые значения: строка, целое число в ASPLAIN или ASDOT формате. | ||
| auth_pass (добавлено в 2.4.4)
| нет | none | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это требуется. Если authorize равно false, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| authorize (добавлено в 2.4.4)
| нет |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой каких-либо команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| default_originate | нет |
| Активировать функцию default-originate. | |
| default_originate_route_map | нет | Необязательный маршрутный файл для свойства default_originate. Может использоваться независимо или в сочетании с default_originate. Допустимые значения: строка, определяющая имя маршрутного файла, или 'default'. | ||
| filter_list_in | нет | Допустимые значения: строка, определяющая имя списка фильтров, или 'default'. | ||
| filter_list_out | нет | Допустимые значения: строка, определяющая имя списка фильтров, или 'default'. | ||
| host | да | Указывает имя или адрес DNS хоста для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| 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. | |
| password | нет | Указывает пароль для аутентификации подключения к удалённому устройству. Этот аргумент обычно используется для cli или nxapi транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port | нет | 0 (использовать стандартный порт) | Указывает порт для подключения к удалённому устройству. Применимо к cli или nxapi. Значение порта будет по умолчанию соответствовать стандартному порту транспорта, если в задаче не указано другое. (cli=22, http=80, https=443). | |
| prefix_list_in | нет | Допустимые значения: строка, определяющая имя списка префиксов, или 'default'. | ||
| prefix_list_out | нет | Допустимые значения: строка, определяющая имя списка префиксов, или 'default'. | ||
| provider | нет | Удобный метод, который позволяет передавать все аргументы nxos как объект dict. Все ограничения (обязательные, варианты и т.д.) должны быть выполнены либо отдельными аргументами, либо значениями в этом словаре. | ||
| route_map_in | нет | Допустимые значения: строка, определяющая имя маршрутного файла, или 'default'. | ||
| route_map_out | нет | Допустимые значения: строка, определяющая имя маршрутного файла, или 'default'. | ||
| route_reflector_client | нет |
| Клиент маршрутного рефлектора. | |
| safi | да |
| Идентификатор подсемейства адресов. | |
| send_community | нет |
| Атрибут send-community. | |
| soft_reconfiguration_in | нет |
| Допустимые значения: 'enable' для включения базовой команды; 'always' для добавления ключевого слова always к базовой команде; и 'inherit' для удаления команды на этом уровне (значение команды наследуется с более высокого уровня BGP). | |
| soo | нет | Местоположение источника. Допустимые значения: строка, определяющая VPN extcommunity или 'default'. | ||
| ssh_keyfile | нет | Указывает SSH ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| state | нет | present |
| Определяет, должен ли конфиг присутствовать на устройстве или нет. |
| suppress_inactive | нет |
| Функция suppress-inactive. | |
| timeout (добавлено в 2.3)
| нет | 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результат для длительных команд (sh mac, sh bgp и т.д.). | |
| transport | да | cli | Настраивает транспортное подключение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| unsuppress_map | нет | unsuppress-map. Допустимые значения: строка, определяющая имя маршрутного файла, или 'default'. | ||
| use_ssl | нет |
| Настраивает transport на использование SSL, если установлено в true только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username | нет | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs | нет |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах, использующих самозаверенные сертификаты. Если аргумент transport не nxapi, это значение игнорируется. | |
| vrf | нет | default | Имя VRF. Имя 'default' является допустимым VRF, представляющим глобальный bgp. |
| вес | нет | Значение веса. Допустимые значения — целое число или 'default'. |
Примеры
- 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
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для данного модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| команды | команды, отправленные устройству | всегда | список | ['router bgp 65535', 'neighbor 3.3.3.3', 'address-family ipv4 unicast', 'route-reflector-client'] |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
-
state=absentудаляет всю конфигурацию соседей BGP address-family. - По умолчанию, если поддерживается, удаляет свойства
- Для сброса максимальной конфигурации префиксов, необходимо только
max_prefix_limit=default.
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.
Информация о техническом обслуживании
Для получения дополнительной информации о поддержке этого модуля компанией Red Hat, обратитесь к этому knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
Для получения помощи в разработке модулей, если у вас есть желание, пожалуйста, ознакомьтесь с Информация о сообществе и вклад, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/nxos_bgp_neighbor_af_module.html
