cisco.meraki.networks_switch_routing_multicast модуль — Модуль ресурсов для networks_switch_routing_multicast

Примечание

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

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

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

Для использования в playbook укажите: cisco.meraki.networks_switch_routing_multicast.

Новое в cisco.meraki 2.16.0

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

Обзор

Управление обновлением операций ресурса networks_switch_routing_multicast.
Обновление настроек мультикаста для сети.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
defaultSettings dictionary	Настройки многоадресной рассылки по умолчанию для всей сети. Прослушивание IGMP и настройки затопления неизвестного многоадресного трафика включены по умолчанию.
floodUnknownMulticastTrafficEnabled boolean	Настройка затопления неизвестного многоадресного трафика для всей сети. Варианты: `false` `true`
igmpSnoopingEnabled boolean	Настройка прослушивания IGMP для всей сети. Варианты: `false` `true`
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), время ожидания повторной попытки Nginx 429 По умолчанию: `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 Значение по умолчанию: `60`
meraki_simulate boolean	meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения? Допустимые значения: `false` ← (по умолчанию) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (integer), максимальное время в секундах для каждого вызова API Значение по умолчанию: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (boolean), отключить всю регистрацию? Тогда вы наедине со своими проблемами! Допустимые значения: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (boolean), методы list* будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами Допустимые значения: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (boolean), повторить попытку, если обнаружена ошибка ограничения скорости 429? Допустимые значения: `false` `true` ← (по умолчанию)
networkId string	Параметр пути NetworkId. Идентификатор сети.
overrides list / elements=dictionary	Массив пар коммутаторов/стеков/профилей и соответствующих настроек многоадресной рассылки. Пустой массив очистит настройки многоадресной рассылки.
floodUnknownMulticastTrafficEnabled boolean	Настройка пересылки неизвестного трафика многоадресной рассылки для коммутаторов, стеков коммутаторов или шаблонов коммутаторов. Допустимые значения: `false` `true`
igmpSnoopingEnabled boolean	Настройка IGMP-перехвата для коммутаторов, стеков коммутаторов или шаблонов коммутаторов. Допустимые значения: `false` `true`
stacks list / elements=string	Список идентификаторов стеков коммутаторов для сетей, не являющихся шаблонами.
switches list / elements=string	Список серийных номеров коммутаторов для сетей, не являющихся шаблонами.
switchProfiles list / elements=string	Список идентификаторов шаблонов коммутаторов для шаблонированных сетей.

Примечания

Примечание

Используемый метод SDK — switch.Switch.update_network_switch_routing_multicast,
Используемые пути — put /networks/{networkId}/switch/routing/multicast,
Не поддерживает check_mode
Плагин работает на узле управления и не использует какие-либо плагины соединения ansible, а вместо этого использует встроенный менеджер соединения из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

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

Примеры

- name: Update all
  cisco.meraki.networks_switch_routing_multicast:
    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
    defaultSettings:
      floodUnknownMulticastTrafficEnabled: true
      igmpSnoopingEnabled: true
    networkId: string
    overrides:
    - floodUnknownMulticastTrafficEnabled: true
      igmpSnoopingEnabled: true
      stacks:
      - '789102'
      - '123456'
      - '129102'
      switchProfiles:
      - '1234'
      - '4567'
      switches:
      - Q234-ABCD-0001
      - Q234-ABCD-0002
      - Q234-ABCD-0003

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

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

Ключ	Описание
meraki_response dictionary	Словарь или список с ответом, возвращенным Cisco Meraki Python SDK Возвращается: всегда Пример: `{"defaultSettings": {"floodUnknownMulticastTrafficEnabled": true, "igmpSnoopingEnabled": true}, "overrides": [{"floodUnknownMulticastTrafficEnabled": true, "igmpSnoopingEnabled": true, "stacks": ["string"], "switchProfiles": ["string"], "switches": ["string"]}]}`

Ключ

Описание

meraki_response

dictionary

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

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

Пример: {"defaultSettings": {"floodUnknownMulticastTrafficEnabled": true, "igmpSnoopingEnabled": true}, "overrides": [{"floodUnknownMulticastTrafficEnabled": true, "igmpSnoopingEnabled": true, "stacks": ["string"], "switchProfiles": ["string"], "switches": ["string"]}]}

Авторы

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_switch_routing_multicast_module.html