100%

meraki_switch_qos_rules

module
Manage Meraki switch QoS rules
Added in version 0.1.0

Synopsis

  • Manage Meraki switch QoS rules for a network.
  • Network-scoped. Supports merged, replaced, deleted, and gathered states.

Author

Cisco Meraki

Parameters

config (list/dict)

List of QoS rule configurations.

dscp (int)

DSCP tag for incoming packet (-1 to trust incoming DSCP).

dst_port (int)

Destination port (TCP/UDP only).

dst_port_range (str)

Destination port range (TCP/UDP only).

protocol (str)

Protocol (ANY, TCP, or UDP).

qos_rule_id (str)

Server-assigned rule ID. Discover via state=gathered.

src_port (int)

Source port (TCP/UDP only).

src_port_range (str)

Source port range (TCP/UDP only).

vlan (int)

VLAN of incoming packet (null matches any VLAN).

network_id (str) required

The network ID.

state (str)
mergedreplacedoverriddendeletedgathered

The state of the resource.

Sample Task

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

- name: Meraki Switch Qos Rules task
  cisco.meraki_rm.meraki_switch_qos_rules:
    network_id: "192.168.1.0/24"
    config:
      - dscp: 0
        dst_port: 0
        dst_port_range: 22
        protocol: "protocol_value"
        qos_rule_id: "qos_rule_id_value"
        src_port: 0
        src_port_range: "/path/to/file"
        vlan: 0
    state: merged
- name: Meraki Switch Qos Rules task
  cisco.meraki_rm.meraki_switch_qos_rules:
    network_id: "192.168.1.0/24"
    config:  # optional
      - dscp: 0  # optional
        dst_port: 0  # optional
        dst_port_range: 22  # optional
        protocol: "protocol_value"  # optional
        qos_rule_id: "qos_rule_id_value"  # optional
        src_port: 0  # optional
        src_port_range: "/path/to/file"  # optional
        vlan: 0  # optional
    state: merged  # optional
- name: Meraki Switch Qos Rules task
  cisco.meraki_rm.meraki_switch_qos_rules:
    network_id: "192.168.1.0/24"  # (str, required) The network ID.
    config:  # (list, optional) List of QoS rule configurations.
      - dscp: 0  # (int, optional) DSCP tag for incoming packet (-1 to trust incoming DSCP).
        dst_port: 0  # (int, optional) Destination port (TCP/UDP only).
        dst_port_range: 22  # (str, optional) Destination port range (TCP/UDP only).
        protocol: "protocol_value"  # (str, optional) Protocol (ANY, TCP, or UDP).
        qos_rule_id: "qos_rule_id_value"  # (str, optional) Server-assigned rule ID. Discover via C(state=gathered).
        src_port: 0  # (int, optional) Source port (TCP/UDP only).
        src_port_range: "/path/to/file"  # (str, optional) Source port range (TCP/UDP only).
        vlan: 0  # (int, optional) VLAN of incoming packet (null matches any VLAN).
    state: merged  # (str, optional) The state of the resource.

Notes

  • This resource has no canonical key (Category C — gather-first).
  • Use state=gathered to discover qos_rule_id values, then reference them in subsequent tasks.

Examples

Define Expected Configuration
- name: Define expected configuration
  ansible.builtin.set_fact:
    expected_config:
      dscp: 1
      vlan: 1
      protocol: TCP
      src_port: 1
      dst_port: 1
      src_port_range: 1-1024
      dst_port_range: 1-1024
Create Switch_qos_rules With Merged State
- name: Create switch_qos_rules with merged state
  cisco.meraki_rm.meraki_switch_qos_rules:
    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 QoS rules — full resource replacement
Define Replacement Configuration
- name: Define replacement configuration
  ansible.builtin.set_fact:
    expected_config:
      dscp: 1
      vlan: 20
      protocol: TCP
      src_port: 1
      dst_port: 1
      src_port_range: 1-1024
      dst_port_range: 1-1024
Replace Switch_qos_rules Configuration
- name: Replace switch_qos_rules configuration
  cisco.meraki_rm.meraki_switch_qos_rules:
    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 QoS rules — override all instances # Ensures ONLY these resources exist; any not listed are deleted.
Define Desired-state Configuration
- name: Define desired-state configuration
  ansible.builtin.set_fact:
    expected_config:
      dscp: 1
      vlan: 20
      protocol: TCP
      src_port: 1
      dst_port: 1
      src_port_range: 1-1024
      dst_port_range: 1-1024
Override All Switch_qos_rules — Desired State Only
- name: Override all switch_qos_rules — desired state only
  cisco.meraki_rm.meraki_switch_qos_rules:
    network_id: "N_123456789012345678"
    state: overridden
    config:
      - "{{ expected_config }}"
  register: override_result
Assert Resources Were Overridden
- name: Assert resources were overridden
  ansible.builtin.assert:
    that:
      - override_result is changed
      - override_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: "{{ override_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 QoS rules — gather current configuration
Gather Current Switch_qos_rules Configuration
- name: Gather current switch_qos_rules configuration
  cisco.meraki_rm.meraki_switch_qos_rules:
    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
Task Output:
# Manage Meraki switch QoS rules — remove configuration
Define Resource To Delete
- name: Define resource to delete
  ansible.builtin.set_fact:
    expected_config:
      dscp: 1
Delete Switch_qos_rules Configuration
- name: Delete switch_qos_rules configuration
  cisco.meraki_rm.meraki_switch_qos_rules:
    network_id: "N_123456789012345678"
    state: deleted
    config:
      - "{{ expected_config }}"
  register: delete_result
Assert Resource Was Deleted
- name: Assert resource was deleted
  ansible.builtin.assert:
    that:
      - delete_result is changed
      - delete_result is not failed
---
# Manage Meraki switch QoS rules — create or update

- name: Define expected configuration
  ansible.builtin.set_fact:
    expected_config:
      dscp: 1
      vlan: 1
      protocol: TCP
      src_port: 1
      dst_port: 1
      src_port_range: 1-1024
      dst_port_range: 1-1024

- name: Create switch_qos_rules with merged state
  cisco.meraki_rm.meraki_switch_qos_rules:
    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 QoS rules — full resource replacement

- name: Define replacement configuration
  ansible.builtin.set_fact:
    expected_config:
      dscp: 1
      vlan: 20
      protocol: TCP
      src_port: 1
      dst_port: 1
      src_port_range: 1-1024
      dst_port_range: 1-1024

- name: Replace switch_qos_rules configuration
  cisco.meraki_rm.meraki_switch_qos_rules:
    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 QoS rules — override all instances
# Ensures ONLY these resources exist; any not listed are deleted.

- name: Define desired-state configuration
  ansible.builtin.set_fact:
    expected_config:
      dscp: 1
      vlan: 20
      protocol: TCP
      src_port: 1
      dst_port: 1
      src_port_range: 1-1024
      dst_port_range: 1-1024

- name: Override all switch_qos_rules — desired state only
  cisco.meraki_rm.meraki_switch_qos_rules:
    network_id: "N_123456789012345678"
    state: overridden
    config:
      - "{{ expected_config }}"
  register: override_result

- name: Assert resources were overridden
  ansible.builtin.assert:
    that:
      - override_result is changed
      - override_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: "{{ override_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 QoS rules — gather current configuration

- name: Gather current switch_qos_rules configuration
  cisco.meraki_rm.meraki_switch_qos_rules:
    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

# Manage Meraki switch QoS rules — remove configuration

- name: Define resource to delete
  ansible.builtin.set_fact:
    expected_config:
      dscp: 1

- name: Delete switch_qos_rules configuration
  cisco.meraki_rm.meraki_switch_qos_rules:
    network_id: "N_123456789012345678"
    state: deleted
    config:
      - "{{ expected_config }}"
  register: delete_result

- name: Assert resource was deleted
  ansible.builtin.assert:
    that:
      - delete_result is changed
      - delete_result is not failed

Return Values

config
list — returned: always
The resulting resource configuration.