Spec-Zone.ru › Ansible

модуль cisco.meraki.networks_appliance_vpn_bgp – модуль ресурсов для networks _appliance _vpn _bgp

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install cisco.meraki. Для использования этого модуля необходимы дополнительные требования; подробную информацию см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: cisco.meraki.networks_appliance_vpn_bgp.

Добавлено в cisco.meraki 1.0.0

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Управление операцией обновления ресурса networks _appliance _vpn _bgp.
  • Обновление конфигурации 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 (целое число), время ожидания перед повтором при ошибке параллелизма пакета действий

По умолчанию: 60

meraki_api_key

string / обязательный

meraki_api_key (строка), ключ API, созданный на панели управления; его также можно задать с помощью переменной среды MERAKI_DASHBOARD_API_KEY

meraki_base_url

string

meraki_base_url (строка), базовый адрес для всех конечных ресурсов

По умолчанию: "https://api.meraki.com/api/v1"

meraki_be_geo_id

string

meraki_be_geo_id (строка), необязательный идентификатор партнёра для отслеживания использования API; его также можно задать с помощью переменной среды BE_GEO_ID

По умолчанию: ""

meraki_certificate_path

string

meraki_certificate_path (строка), путь к сертификату для проверки TLS/SSL при работе за локальным прокси-сервером

По умолчанию: ""

meraki_inherit_logging_config

boolean

meraki_inherit_logging_config (логическое значение), использовать собственный экземпляр регистратора

Допустимые значения:

  • false ← (по умолчанию)
  • true

meraki_log_file_prefix

string

meraki_log_file_prefix (строка), к имени файла журнала добавляются дата и время

По умолчанию: "meraki_api_"

meraki_log_path

string

log_path (строка), путь для сохранения журнала; если он не указан, используется рабочий каталог скрипта

По умолчанию: ""

meraki_maximum_retries

integer

meraki_maximum_retries (целое число), максимальное число повторных попыток при получении ошибок 429 или других ошибок на стороне сервера

По умолчанию: 2

meraki_nginx_429_retry_wait_time

integer

meraki_nginx_429_retry_wait_time (целое число), время ожидания перед повтором при ошибке 429 от Nginx

По умолчанию: 60

meraki_output_log

boolean

meraki_output_log (логическое значение), создавать файл журнала вывода?

Допустимые значения:

  • false
  • true ← (по умолчанию)

meraki_print_console

boolean

meraki_print_console (логическое значение), выводить журнал в консоль?

Допустимые значения:

  • false
  • true ← (по умолчанию)

meraki_requests_proxy

string

meraki_requests_proxy (строка), адрес и порт прокси-сервера для HTTPS, если требуется

По умолчанию: ""

meraki_retry_4xx_error

boolean

meraki_retry_4xx_error (логическое значение), повторять попытку при возникновении другой ошибки 4XX (кроме 429)?

Допустимые значения:

  • false ← (по умолчанию)
  • true

meraki_retry_4xx_error_wait_time

integer

meraki_retry_4xx_error_wait_time (целое число), время ожидания перед повтором при другой ошибке 4XX

По умолчанию: 60

meraki_simulate

boolean

meraki_simulate (логическое значение), имитировать запросы POST/PUT/DELETE, чтобы предотвратить внесение изменений?

Допустимые значения:

  • false ← (по умолчанию)
  • true

meraki_single_request_timeout

integer

meraki_single_request_timeout (целое число), максимальное время в секундах для каждого вызова API

По умолчанию: 60

meraki_suppress_logging

boolean

meraki_suppress_logging (логическое значение), отключить ведение всех журналов? Тогда вы действуете на свой страх и риск!

Допустимые значения:

  • false ← (по умолчанию)
  • true

meraki_use_iterator_for_get_pages

boolean

meraki_use_iterator_for_get_pages (логическое значение), методы list* будут возвращать итератор с каждым объектом вместо полного списка всех элементов

Допустимые значения:

  • false ← (по умолчанию)
  • true

meraki_wait_on_rate_limit

boolean

meraki_wait_on_rate_limit (логическое значение), повторять попытку при ошибке ограничения частоты запросов 429?

Допустимые значения:

  • false
  • true ← (по умолчанию)

neighbors

list / elements=dictionary

Список соседей BGP. Этот список заменяет существующий набор соседей. Если параметр не указан, его значение не обновляется.

allowTransit

boolean

Если эта функция включена, устройство Meraki будет анонсировать маршруты, полученные от других автономных систем, позволяя тем самым передавать трафик между автономными системами через эту AS. Если параметр не указан, по умолчанию используется false.

Допустимые значения:

  • 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 соседа.

multiExitDiscriminator

integer

Настраивает локальную метрику, связанную с маршрутами, полученными от удалённого узла. Предпочтение отдаётся маршрутам от узлов с меньшей метрикой. Значение должно быть целым числом от 0 до 4294967295. MED занимает 6-е место в дереве принятия решений, если от нескольких узлов получены идентичные маршруты.

nextHopIp

string

Адрес IPv4 удалённого узла BGP, который установит сеанс TCP с локальным MX.

pathPrepend

list / elements=integer

Добавляет значения в начало атрибута BGP AS_PATH, связанного с маршрутами, полученными от удалённого узла. Настраиваемое значение — ASN для добавления. Длина массива не должна превышать 10 элементов, а каждый ASN в массиве должен быть целым числом от 1 до 4294967295. AS_PATH занимает 4-е место в дереве принятия решений, если от нескольких узлов получены идентичные маршруты.

receiveLimit

integer

Лимит приёма — максимальное количество маршрутов, которые можно получить от любого узла BGP. Значение лимита должно быть целым числом от 0 до 2147483647. Если параметр не указан, по умолчанию используется 0.

remoteAsNumber

integer

Удалённый ASN соседа. Удалённый ASN должен быть целым числом от 1 до 4294967295.

sourceInterface

string

Исходящий интерфейс для пирингового соединения с удалённым узлом BGP. Допустимые значения: ‘wan{NUMBER}’ (например, ‘wan3’) или ‘vlan{VLAN ID}’ (например, ‘vlan123’).

ttlSecurity

dictionary

Параметры защиты TTL для BGP, предотвращающей поддельные IP-атаки на сеансы пиринговых соединений BGP.

enabled

boolean

Логическое значение, включающее или отключающее защиту TTL для BGP.

Допустимые значения:

  • false
  • true

weight

integer

Задаёт локальный вес маршрутов, полученных от удалённого узла. Предпочтение отдаётся маршрутам от узлов с большим весом. Значение должно быть целым числом от 0 до 49.

networkId

string

Параметр пути NetworkId. Идентификатор сети.

Примечания

Примечание

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

См. также

См. также

Документация 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_caller: "{{ meraki_caller }}"
    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
        authentication:
          password: abc123
        ebgpHoldTimer: 180
        ebgpMultihop: 2
        ip: 10.10.10.22
        ipv6:
          address: 2002::1234:abcd:ffff:c0a8:101
        multiExitDiscriminator: 2
        nextHopIp: 1.2.3.4
        pathPrepend:
          - 1
          - 2
        receiveLimit: 120
        remoteAsNumber: 64343
        sourceInterface: wan1
        ttlSecurity:
          enabled: false
        weight: 10
    networkId: string

Возвращаемые значения

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

Ключ

Описание

meraki_response

dictionary

Словарь или список с ответом, возвращённым Python SDK Cisco Meraki

Возвращается: всегда

Пример: {"asNumber": 0, "enabled": true, "ibgpHoldTimer": 0, "neighbors": [{"allowTransit": true, "authentication": {"password": "string"}, "ebgpHoldTimer": 0, "ebgpMultihop": 0, "ip": "string", "ipv6": {"address": "string"}, "multiExitDiscriminator": 0, "nextHopIp": "string", "pathPrepend": [0], "receiveLimit": 0, "remoteAsNumber": 0, "sourceInterface": "string", "ttlSecurity": {"enabled": true}, "weight": 0}]}

Авторы

  • Francisco Munoz (@fmunoz)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API