Spec-Zone.ru › Ansible

Модуль cisco.meraki.networks_switch_routing_multicast_rendezvous_points — модуль ресурса для networks _switch _routing _multicast _rendezvouspoints

Примечание

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

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

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

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

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

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

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

  • Управление операциями создания, обновления и удаления ресурса networks _switch _routing _multicast _rendezvouspoints.
  • Создание точки rendezvous для многоадресной рассылки.
  • Удаление точки rendezvous для многоадресной рассылки.
  • Обновление точки rendezvous для многоадресной рассылки.

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

interfaceIp

строка

IP-адрес интерфейса, на котором необходимо создать RP.

meraki_action_batch_retry_wait_time

целое число

meraki_action_batch_retry_wait_time (целое число), время ожидания перед повтором при ошибке параллельного выполнения пакета действий

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

meraki_api_key

строка / обязательный

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

meraki_base_url

строка

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

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

meraki_be_geo_id

строка

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

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

meraki_certificate_path

строка

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

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

meraki_inherit_logging_config

логическое значение

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

Варианты:

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

meraki_log_file_prefix

строка

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

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

meraki_log_path

строка

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

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

meraki_maximum_retries

целое число

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

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

meraki_nginx_429_retry_wait_time

целое число

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

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

meraki_output_log

логическое значение

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

Варианты:

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

meraki_print_console

логическое значение

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

Варианты:

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

meraki_requests_proxy

строка

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

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

meraki_retry_4xx_error

логическое значение

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

Варианты:

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

meraki_retry_4xx_error_wait_time

целое число

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

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

meraki_simulate

логическое значение

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

Варианты:

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

meraki_single_request_timeout

целое число

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

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

meraki_suppress_logging

логическое значение

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

Варианты:

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

meraki_use_iterator_for_get_pages

логическое значение

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

Варианты:

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

meraki_wait_on_rate_limit

логическое значение

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

Варианты:

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

multicastGroup

строка

‘Any’ или IP-адрес группы многоадресной рассылки.

networkId

строка

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

rendezvousPointId

строка

Параметр пути RendezvousPointId. Идентификатор точки rendezvous.

vrf

словарь

VRF с интерфейсом L3, на котором включен PIM.

name

строка

Имя VRF.

Примечания

Примечание

  • Используемые методы SDK: switch.Switch.create_network_switch_routing_multicast_rendezvous_point, switch.Switch.delete_network_switch_routing_multicast_rendezvous_point, switch.Switch.update_network_switch_routing_multicast_rendezvous_point,
  • Используемые пути: post /networks/{networkId}/switch/routing/multicast/rendezvousPoints, delete /networks/{networkId}/switch/routing/multicast/rendezvousPoints/{rendezvousPointId}, put /networks/{networkId}/switch/routing/multicast/rendezvousPoints/{rendezvousPointId},
  • Не поддерживает check_mode
  • Плагин запускается на управляющем узле и не использует плагины подключения Ansible, а вместо этого применяет встроенный диспетчер подключений
  • из Cisco Dashboard API Python (SDK)
  • Параметры, начинающиеся с dnac_, используются Python SDK Cisco DNAC для установления подключения

См. также

См. также

Документация Cisco Meraki по switch createNetworkSwitchRoutingMulticastRendezvousPoint

Полное описание API createNetworkSwitchRoutingMulticastRendezvousPoint.

Документация Cisco Meraki по switch deleteNetworkSwitchRoutingMulticastRendezvousPoint

Полное описание API deleteNetworkSwitchRoutingMulticastRendezvousPoint.

Документация Cisco Meraki по switch updateNetworkSwitchRoutingMulticastRendezvousPoint

Полное описание API updateNetworkSwitchRoutingMulticastRendezvousPoint.

Примеры

- name: Create
  cisco.meraki.networks_switch_routing_multicast_rendezvous_points:
    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
    interfaceIp: 192.168.1.2
    multicastGroup: Any
    networkId: string
    vrf:
      name: Blue
- name: Delete by id
  cisco.meraki.networks_switch_routing_multicast_rendezvous_points:
    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: absent
    networkId: string
    rendezvousPointId: string
- name: Update by id
  cisco.meraki.networks_switch_routing_multicast_rendezvous_points:
    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
    interfaceIp: 192.168.1.2
    multicastGroup: Any
    networkId: string
    rendezvousPointId: string
    vrf:
      name: Blue

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

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

Ключ

Описание

meraki_response

словарь

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

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

Пример: {"interfaceIp": "string", "interfaceName": "string", "multicastGroup": "string", "rendezvousPointId": "string", "serial": "string"}

Авторы

  • 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_switch_routing_multicast_rendezvous_points_module.html

Spec-Zone.ru

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