Модуль cisco.meraki.networks_appliance_vpn_bgp — Модуль ресурсов для сетей _appliance _vpn _bgp

Примечание

Этот модуль входит в коллекцию cisco.meraki (версия 2.18.2).

Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.meraki. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Для использования в книге задач укажите: cisco.meraki.networks_appliance_vpn_bgp.

Новое в cisco.meraki 2.16.0

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Значения возврата

Обзор

Управление обновлением операции ресурса сетей _appliance _vpn _bgp.
Обновление конфигурации Hub BGP.

Примечание

Этот модуль имеет соответствующий плагин действий.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
asNumber integer	Номер автономной системы (ASN) необходим, если вы хотите запустить BGP и установить связь с другим BGP-устройством за пределами домена Auto VPN. Этот ASN будет применен ко всему домену Auto VPN. Поддерживается весь 4-байтовый диапазон ASN. Таким образом, ASN должен быть целым числом от 1 до 4294967295. При отсутствии это поле не обновляется. Если значение отсутствует, используется значение по умолчанию 64512.
enabled boolean	Булево значение для включения или отключения конфигурации BGP. Когда BGP включен, asNumber (ASN) будет автоматически заполнен предварительно настроенным ASN на других концентраторах или значением по умолчанию, если ASN не настроен. Варианты: `false` `true`
ibgpHoldTimer integer	Таймер удержания iBGP в секундах. Таймер удержания iBGP должен быть целым числом от 12 до 240. При отсутствии это поле не обновляется. Если значение отсутствует, используется значение по умолчанию 240.
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (integer), время ожидания повторной попытки при ошибке параллельной обработки действий По умолчанию: `60`
meraki_api_key string / required	meraki_api_key (string), API-ключ, сгенерированный на панели управления; может быть также установлен как переменная окружения MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (string), предшествует всем конечным точкам ресурсов По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (string), необязательный идентификатор партнера для отслеживания использования API; может быть также установлен как переменная окружения BE_GEO_ID По умолчанию: `""`
meraki_caller string	meraki_caller (string), необязательный идентификатор для отслеживания использования API; может быть также установлен как переменная окружения MERAKI_PYTHON_SDK_CALLER По умолчанию: `""`
meraki_certificate_path string	meraki_certificate_path (string), путь для проверки сертификата TLS/SSL, если используется локальный прокси-сервер По умолчанию: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (boolean), наследует ваш собственный экземпляр логгера Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (string), имя файла журнала с добавлением даты и времени По умолчанию: `"meraki_api_"`
meraki_log_path string	log_path (string), путь к выходному журналу; по умолчанию, рабочий каталог скрипта, если не указано иначе По умолчанию: `""`
meraki_maximum_retries integer	meraki_maximum_retries (integer), повторить до этого количества раз при возникновении ошибок 429 или других ошибок на стороне сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (integer), время ожидания повторной попытки при ошибке 429 Nginx По умолчанию: `60`
meraki_output_log boolean	meraki_output_log (boolean), создать файл выходного журнала? Варианты: `false` `true` ← (по умолчанию)
meraki_print_console boolean	meraki_print_console (boolean), выводить сообщения журнала на консоль? Варианты: `false` `true` ← (по умолчанию)
meraki_requests_proxy string	meraki_requests_proxy (string), прокси-сервер и порт, если необходимо, для HTTPS По умолчанию: `""`
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (boolean), повторить попытку при возникновении других ошибок 4XX (кроме 429)? Варианты: `false` ← (по умолчанию) `true`

meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (integer), время ожидания повтора ошибки 4XX Default: `60`
meraki_simulate boolean	meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения? Choices: `false` ← (default) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (integer), максимальное количество секунд для каждого вызова API Default: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (boolean), отключить все логирование? тогда вы сами за себя! Choices: `false` ← (default) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (boolean), методы list* будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами Choices: `false` ← (default) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (boolean), повторить попытку, если обнаружена ошибка ограничения скорости 429? Choices: `false` `true` ← (default)
neighbors list / elements=dictionary	Список соседей BGP. Этот список заменяет существующий набор соседей. При отсутствии это поле не обновляется.
allowTransit boolean	Когда эта функция включена, устройство Meraki будет объявлять маршруты, полученные от других автономных систем, тем самым позволяя трафику между автономными системами транзитировать через эту AS. При отсутствии, по умолчанию используется false. Choices: `false` `true`
authentication dictionary	Параметры аутентификации между BGP-пирами.
password string	Пароль для настройки аутентификации MD5 между BGP-пирами.
ebgpHoldTimer integer	Таймер удержания eBGP в секундах для каждого соседа. Таймер удержания eBGP должен быть целым числом от 12 до 240.
ebgpMultihop integer	Настройте это, если соседний узел не является смежным. Многоходовой eBGP должен быть целым числом от 1 до 255.
ip string	IPv4-адрес соседа.
ipv6 dictionary	Информация о IPv6-адресе соседа, требуется, если `ip` отсутствует.
address string	IPv6-адрес соседа.
nextHopIp string	IPv4-адрес удаленного BGP-пира, который установит TCP-сеанс с локальным MX.
receiveLimit integer	Предел приема — это максимальное количество маршрутов, которые могут быть получены от любого BGP-пира. Предел приема должен быть целым числом от 0 до 4294967295. При отсутствии, по умолчанию используется 0.
remoteAsNumber integer	Удаленный ASN соседа. Удаленный ASN должен быть целым числом от 1 до 4294967295.
sourceInterface string	Выходной интерфейс для пиринга с удаленным BGP-пиром. Допустимые значения: ‘wan1’, ‘wan2’ или ‘vlan{VLAN ID}’ (например, ‘vlan123’).
ttlSecurity dictionary	Параметры безопасности TTL BGP для защиты сеансов BGP-пиринга от поддельных IP-атак.

enabled boolean	Булево значение для включения или отключения безопасности TTL для BGP. Варианты: `false` `true`
networkId string	Параметр пути networkId. Идентификатор сети.

Примечания

Примечание

Используемый метод SDK: appliance.Appliance.update_network_appliance_vpn_bgp,
Используемые пути: put /networks/{networkId}/appliance/vpn/bgp,
Не поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный диспетчер подключений из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

Документация Cisco Meraki по обновлению appliance updateNetworkApplianceVpnBgp: Полное описание API updateNetworkApplianceVpnBgp.

Примеры

- name: Update all
  cisco.meraki.networks_appliance_vpn_bgp:
    meraki_api_key: "{{meraki_api_key}}"
    meraki_base_url: "{{meraki_base_url}}"
    meraki_single_request_timeout: "{{meraki_single_request_timeout}}"
    meraki_certificate_path: "{{meraki_certificate_path}}"
    meraki_requests_proxy: "{{meraki_requests_proxy}}"
    meraki_wait_on_rate_limit: "{{meraki_wait_on_rate_limit}}"
    meraki_nginx_429_retry_wait_time: "{{meraki_nginx_429_retry_wait_time}}"
    meraki_action_batch_retry_wait_time: "{{meraki_action_batch_retry_wait_time}}"
    meraki_retry_4xx_error: "{{meraki_retry_4xx_error}}"
    meraki_retry_4xx_error_wait_time: "{{meraki_retry_4xx_error_wait_time}}"
    meraki_maximum_retries: "{{meraki_maximum_retries}}"
    meraki_output_log: "{{meraki_output_log}}"
    meraki_log_file_prefix: "{{meraki_log_file_prefix}}"
    meraki_log_path: "{{meraki_log_path}}"
    meraki_print_console: "{{meraki_print_console}}"
    meraki_suppress_logging: "{{meraki_suppress_logging}}"
    meraki_simulate: "{{meraki_simulate}}"
    meraki_be_geo_id: "{{meraki_be_geo_id}}"
    meraki_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
    meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
    state: present
    asNumber: 64515
    enabled: true
    ibgpHoldTimer: 120
    neighbors:
    - allowTransit: true
      ebgpHoldTimer: 180
      ebgpMultihop: 2
      ip: 10.10.10.22
      receiveLimit: 120
      remoteAsNumber: 64343
    networkId: string

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
meraki_response словарь	Словарь или список с ответом, возвращенным Cisco Meraki Python SDK Возвращается: всегда Пример: `{}`

Авторы

Francisco Munoz (@fmunoz)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/meraki/networks_appliance_vpn_bgp_module.html