W3cubDocs

/Ansible

cisco.meraki.networks_switch_routing_multicast module – Resource module for networks _switch _routing _multicast

Note

This module is part of the cisco.meraki collection (version 2.21.4).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.meraki. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.meraki.networks_switch_routing_multicast.

New in cisco.meraki 1.0.0

Synopsis
Requirements
Parameters
Notes
See Also
Examples
Return Values

Synopsis

Manage operation update of the resource networks _switch _routing _multicast.
Update multicast settings for a network.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

meraki >= 2.4.9
python >= 3.5

Parameters

Parameter	Comments
defaultSettings dictionary	Default multicast setting for entire network. IGMP snooping and Flood unknown multicast traffic settings are enabled by default.
floodUnknownMulticastTrafficEnabled boolean	Flood unknown multicast traffic setting for entire network. Choices: `false` `true`
igmpSnoopingEnabled boolean	IGMP snooping setting for entire network. Choices: `false` `true`
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (integer), action batch concurrency error retry wait time Default: `60`
meraki_api_key string / required	meraki_api_key (string), API key generated in dashboard; can also be set as an environment variable MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (string), preceding all endpoint resources Default: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (string), optional partner identifier for API usage tracking; can also be set as an environment variable BE_GEO_ID Default: `""`
meraki_certificate_path string	meraki_certificate_path (string), path for TLS/SSL certificate verification if behind local proxy Default: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (boolean), Inherits your own logger instance Choices: `false` ← (default) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (string), log file name appended with date and timestamp Default: `"meraki_api_"`
meraki_log_path string	log_path (string), path to output log; by default, working directory of script if not specified Default: `""`
meraki_maximum_retries integer	meraki_maximum_retries (integer), retry up to this many times when encountering 429s or other server-side errors Default: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (integer), Nginx 429 retry wait time Default: `60`
meraki_output_log boolean	meraki_output_log (boolean), create an output log file? Choices: `false` `true` ← (default)
meraki_print_console boolean	meraki_print_console (boolean), print logging output to console? Choices: `false` `true` ← (default)
meraki_requests_proxy string	meraki_requests_proxy (string), proxy server and port, if needed, for HTTPS Default: `""`
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (boolean), retry if encountering other 4XX error (besides 429)? Choices: `false` ← (default) `true`
meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (integer), other 4XX error retry wait time Default: `60`
meraki_simulate boolean	meraki_simulate (boolean), simulate POST/PUT/DELETE calls to prevent changes? Choices: `false` ← (default) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (integer), maximum number of seconds for each API call Default: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (boolean), disable all logging? you’re on your own then! Choices: `false` ← (default) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (boolean), list* methods will return an iterator with each object instead of a complete list with all items Choices: `false` ← (default) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (boolean), retry if 429 rate limit error encountered? Choices: `false` `true` ← (default)
networkId string	NetworkId path parameter. Network ID.
overrides list / elements=dictionary	Array of paired switches/stacks/profiles and corresponding multicast settings. An empty array will clear the multicast settings.
floodUnknownMulticastTrafficEnabled boolean	Flood unknown multicast traffic setting for switches, switch stacks or switch templates. Choices: `false` `true`
igmpSnoopingEnabled boolean	IGMP snooping setting for switches, switch stacks or switch templates. Choices: `false` `true`
stacks list / elements=string	List of switch stack ids for non-template network.
switches list / elements=string	List of switch serials for non-template network.
switchProfiles list / elements=string	List of switch templates ids for template network.

Notes

Note

SDK Method used are switch.Switch.update_network_switch_routing_multicast,
Paths used are put /networks/{networkId}/switch/routing/multicast,
Does not support check_mode
The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager
from Cisco Dashboard API Python(SDK)
The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection

Examples

- 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_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
    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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
meraki_response dictionary	A dictionary or list with the response returned by the Cisco Meraki Python SDK Returned: always Sample: `{"defaultSettings": {"floodUnknownMulticastTrafficEnabled": true, "igmpSnoopingEnabled": true}, "overrides": [{"floodUnknownMulticastTrafficEnabled": true, "igmpSnoopingEnabled": true, "stacks": ["string"], "switchProfiles": ["string"], "switches": ["string"]}]}`

Authors

Francisco Munoz (@fmunoz)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 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

cisco.meraki.networks_switch_routing_multicast module – Resource module for networks _switch _routing _multicast

Synopsis

Requirements

Parameters

Notes

See Also

Examples

Return Values

Authors

Collection links