cisco.meraki_rm.meraki_switch

Synopsis Parameters Sample Task Examples Return Values

Synopsis

Manage Meraki switch settings for a network (consolidated).
Singleton per network (MTU, storm control, DSCP, AMI, general).
Supports merged, replaced, and gathered states.

Author

Cisco Meraki

Parameters

▶ config (list/dict)

Switch settings configuration (singleton).

broadcast_threshold (int)

Broadcast storm control threshold.

default_mtu_size (int)

MTU size for the entire network.

mappings (list/dict)

DSCP to CoS mappings.

multicast_threshold (int)

Multicast storm control threshold.

overrides (list/dict)

Override MTU for individual switches.

power_exceptions (list/dict)

Per-switch power exceptions.

unknown_unicast_threshold (int)

Unknown unicast storm control threshold.

use_combined_power (bool)

Use combined power for secondary power supplies.

network_id (str) required

The network ID.

state (str)

mergedreplacedgathered

The state of the resource.

Sample Task

A template task showing all available parameters with their defaults or example values.

- name: Meraki Switch Settings task
  cisco.meraki_rm.meraki_switch_settings:
    network_id: "192.168.1.0/24"
    config:
      - broadcast_threshold: 0
        default_mtu_size: 0
        mappings:
          - {}
        multicast_threshold: 0
        overrides:
          - {}
        power_exceptions:
          - {}
        unknown_unicast_threshold: 0
        use_combined_power: true
    state: merged

- name: Meraki Switch Settings task
  cisco.meraki_rm.meraki_switch_settings:
    network_id: "192.168.1.0/24"
    config:  # optional
      - broadcast_threshold: 0  # optional
        default_mtu_size: 0  # optional
        mappings:  # optional
          - {}
        multicast_threshold: 0  # optional
        overrides:  # optional
          - {}
        power_exceptions:  # optional
          - {}
        unknown_unicast_threshold: 0  # optional
        use_combined_power: true  # optional
    state: merged  # optional

- name: Meraki Switch Settings task
  cisco.meraki_rm.meraki_switch_settings:
    network_id: "192.168.1.0/24"  # (str, required) The network ID.
    config:  # (list, optional) Switch settings configuration (singleton).
      - broadcast_threshold: 0  # (int, optional) Broadcast storm control threshold.
        default_mtu_size: 0  # (int, optional) MTU size for the entire network.
        mappings:  # (list, optional) DSCP to CoS mappings.
          - {}
        multicast_threshold: 0  # (int, optional) Multicast storm control threshold.
        overrides:  # (list, optional) Override MTU for individual switches.
          - {}
        power_exceptions:  # (list, optional) Per-switch power exceptions.
          - {}
        unknown_unicast_threshold: 0  # (int, optional) Unknown unicast storm control threshold.
        use_combined_power: true  # (bool, optional) Use combined power for secondary power supplies.
    state: merged  # (str, optional) The state of the resource.

Examples

Define Expected Configuration

- name: Define expected configuration
  ansible.builtin.set_fact:
    expected_config:
      default_mtu_size: 1
      broadcast_threshold: 1
      multicast_threshold: 1
      unknown_unicast_threshold: 1
      use_combined_power: true

Create Switch_settings With Merged State

- name: Create switch_settings with merged state
  cisco.meraki_rm.meraki_switch_settings:
    network_id: "N_123456789012345678"
    state: merged
    config:
      - "{{ expected_config }}"
  register: merge_result

Assert Resource Was Created

- name: Assert resource was created
  ansible.builtin.assert:
    that:
      - merge_result is changed
      - merge_result.config | length == 1

Compare Expected Paths To Result (subset Check)

- name: Compare expected paths to result (subset check)
  ansible.builtin.set_fact:
    path_check: "{{ expected_paths | cisco.meraki_rm.path_contained_in(result_paths) }}"
  vars:
    expected_paths: "{{ expected_config | ansible.utils.to_paths }}"
    result_paths: "{{ merge_result.config[0] | ansible.utils.to_paths }}"

Assert All Expected Fields Are Present And Match

- name: Assert all expected fields are present and match
  ansible.builtin.assert:
    that: path_check.contained | bool
    success_msg: "{{ success_msg }}"
    fail_msg: "{{ fail_msg }}"
  vars:
    success_msg: "All expected fields match. Extras: {{ path_check.extras }}"
    fail_msg: "Missing or mismatch: {{ path_check.missing }}. Extras: {{ path_check.extras }}"

Task Output:

# Manage Meraki switch settings (MTU, storm control, DSCP, AMI, general) — full resource replacement

Define Replacement Configuration

- name: Define replacement configuration
  ansible.builtin.set_fact:
    expected_config:
      default_mtu_size: 1
      broadcast_threshold: 1
      multicast_threshold: 1
      unknown_unicast_threshold: 1
      use_combined_power: true

Replace Switch_settings Configuration

- name: Replace switch_settings configuration
  cisco.meraki_rm.meraki_switch_settings:
    network_id: "N_123456789012345678"
    state: replaced
    config:
      - "{{ expected_config }}"
  register: replace_result

Assert Resource Was Replaced

- name: Assert resource was replaced
  ansible.builtin.assert:
    that:
      - replace_result is changed
      - replace_result.config | length == 1

Compare Expected Paths To Result (subset Check)

- name: Compare expected paths to result (subset check)
  ansible.builtin.set_fact:
    path_check: "{{ expected_paths | cisco.meraki_rm.path_contained_in(result_paths) }}"
  vars:
    expected_paths: "{{ expected_config | ansible.utils.to_paths }}"
    result_paths: "{{ replace_result.config[0] | ansible.utils.to_paths }}"

Assert All Expected Fields Are Present And Match

- name: Assert all expected fields are present and match
  ansible.builtin.assert:
    that: path_check.contained | bool
    success_msg: "{{ success_msg }}"
    fail_msg: "{{ fail_msg }}"
  vars:
    success_msg: "All expected fields match. Extras: {{ path_check.extras }}"
    fail_msg: "Missing or mismatch: {{ path_check.missing }}. Extras: {{ path_check.extras }}"

Task Output:

# Manage Meraki switch settings (MTU, storm control, DSCP, AMI, general) — gather current configuration

Gather Current Switch_settings Configuration

- name: Gather current switch_settings configuration
  cisco.meraki_rm.meraki_switch_settings:
    network_id: "N_123456789012345678"
    state: gathered
  register: gathered

Assert Gathered Config Is Not Empty

- name: Assert gathered config is not empty
  ansible.builtin.assert:
    that:
      - gathered.config is defined
      - gathered.config | length > 0
    fail_msg: "Gathered config is empty — expected at least one resource"

Display Gathered Configuration

- name: Display gathered configuration
  ansible.builtin.debug:
    var: gathered.config

---
# Manage Meraki switch settings (MTU, storm control, DSCP, AMI, general) — create or update

- name: Define expected configuration
  ansible.builtin.set_fact:
    expected_config:
      default_mtu_size: 1
      broadcast_threshold: 1
      multicast_threshold: 1
      unknown_unicast_threshold: 1
      use_combined_power: true

- name: Create switch_settings with merged state
  cisco.meraki_rm.meraki_switch_settings:
    network_id: "N_123456789012345678"
    state: merged
    config:
      - "{{ expected_config }}"
  register: merge_result

- name: Assert resource was created
  ansible.builtin.assert:
    that:
      - merge_result is changed
      - merge_result.config | length == 1

- name: Compare expected paths to result (subset check)
  ansible.builtin.set_fact:
    path_check: "{{ expected_paths | cisco.meraki_rm.path_contained_in(result_paths) }}"
  vars:
    expected_paths: "{{ expected_config | ansible.utils.to_paths }}"
    result_paths: "{{ merge_result.config[0] | ansible.utils.to_paths }}"

- name: Assert all expected fields are present and match
  ansible.builtin.assert:
    that: path_check.contained | bool
    success_msg: "{{ success_msg }}"
    fail_msg: "{{ fail_msg }}"
  vars:
    success_msg: "All expected fields match. Extras: {{ path_check.extras }}"
    fail_msg: "Missing or mismatch: {{ path_check.missing }}. Extras: {{ path_check.extras }}"

# Manage Meraki switch settings (MTU, storm control, DSCP, AMI, general) — full resource replacement

- name: Define replacement configuration
  ansible.builtin.set_fact:
    expected_config:
      default_mtu_size: 1
      broadcast_threshold: 1
      multicast_threshold: 1
      unknown_unicast_threshold: 1
      use_combined_power: true

- name: Replace switch_settings configuration
  cisco.meraki_rm.meraki_switch_settings:
    network_id: "N_123456789012345678"
    state: replaced
    config:
      - "{{ expected_config }}"
  register: replace_result

- name: Assert resource was replaced
  ansible.builtin.assert:
    that:
      - replace_result is changed
      - replace_result.config | length == 1

- name: Compare expected paths to result (subset check)
  ansible.builtin.set_fact:
    path_check: "{{ expected_paths | cisco.meraki_rm.path_contained_in(result_paths) }}"
  vars:
    expected_paths: "{{ expected_config | ansible.utils.to_paths }}"
    result_paths: "{{ replace_result.config[0] | ansible.utils.to_paths }}"

- name: Assert all expected fields are present and match
  ansible.builtin.assert:
    that: path_check.contained | bool
    success_msg: "{{ success_msg }}"
    fail_msg: "{{ fail_msg }}"
  vars:
    success_msg: "All expected fields match. Extras: {{ path_check.extras }}"
    fail_msg: "Missing or mismatch: {{ path_check.missing }}. Extras: {{ path_check.extras }}"

# Manage Meraki switch settings (MTU, storm control, DSCP, AMI, general) — gather current configuration

- name: Gather current switch_settings configuration
  cisco.meraki_rm.meraki_switch_settings:
    network_id: "N_123456789012345678"
    state: gathered
  register: gathered

- name: Assert gathered config is not empty
  ansible.builtin.assert:
    that:
      - gathered.config is defined
      - gathered.config | length > 0
    fail_msg: "Gathered config is empty — expected at least one resource"

- name: Display gathered configuration
  ansible.builtin.debug:
    var: gathered.config

Return Values

config

list — returned: always

The resulting resource configuration.