cisco.meraki_rm.meraki_group

Synopsis Parameters Sample Task Notes Examples Return Values

Synopsis

Manage Meraki group policies for a network.
Supports merged, replaced, deleted, and gathered states.

Author

Cisco Meraki

Parameters

▶ config (list/dict)

List of group policy configurations.

bandwidth (dict)

Bandwidth settings for clients.

bonjour_forwarding (dict)

Bonjour forwarding settings.

content_filtering (dict)

Content filtering settings.

firewall_and_traffic_shaping (dict)

Firewall and traffic shaping rules.

group_policy_id (str)

Server-assigned ID, resolved automatically by matching on name.

Provide only to disambiguate when duplicate names exist.

name (str)

Name of the group policy. Required for create.

scheduling (dict)

Schedule for the group policy.

splash_auth_settings (str)

Splash authorization bypass setting.

vlan_tagging (dict)

VLAN tagging settings.

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 Group Policies task
  cisco.meraki_rm.meraki_group_policies:
    network_id: "192.168.1.0/24"
    config:
      - bandwidth: {}
        bonjour_forwarding: {}
        content_filtering: {}
        firewall_and_traffic_shaping: {}
        group_policy_id: "root"
        name: "example_name"
        scheduling: {}
        splash_auth_settings: "splash_auth_settings_value"
        vlan_tagging: {}
    state: merged

- name: Meraki Group Policies task
  cisco.meraki_rm.meraki_group_policies:
    network_id: "192.168.1.0/24"
    config:  # optional
      - bandwidth: {}  # optional
        bonjour_forwarding: {}  # optional
        content_filtering: {}  # optional
        firewall_and_traffic_shaping: {}  # optional
        group_policy_id: "root"  # optional
        name: "example_name"  # optional
        scheduling: {}  # optional
        splash_auth_settings: "splash_auth_settings_value"  # optional
        vlan_tagging: {}  # optional
    state: merged  # optional

- name: Meraki Group Policies task
  cisco.meraki_rm.meraki_group_policies:
    network_id: "192.168.1.0/24"  # (str, required) The network ID.
    config:  # (list, optional) List of group policy configurations.
      - bandwidth: {}  # (dict, optional) Bandwidth settings for clients.
        bonjour_forwarding: {}  # (dict, optional) Bonjour forwarding settings.
        content_filtering: {}  # (dict, optional) Content filtering settings.
        firewall_and_traffic_shaping: {}  # (dict, optional) Firewall and traffic shaping rules.
        group_policy_id: "root"  # (str, optional) Server-assigned ID, resolved automatically by matching on...
        name: "example_name"  # (str, optional) Name of the group policy. Required for create.
        scheduling: {}  # (dict, optional) Schedule for the group policy.
        splash_auth_settings: "splash_auth_settings_value"  # (str, optional) Splash authorization bypass setting.
        vlan_tagging: {}  # (dict, optional) VLAN tagging settings.
    state: merged  # (str, optional) The state of the resource.

Notes

Canonical key: name — identifies the resource in playbooks.
System key: group_policy_id — server-assigned, resolved automatically from gathered state.
Users do not need to provide group_policy_id unless disambiguating duplicate names.

Examples

Define Expected Configuration

- name: Define expected configuration
  ansible.builtin.set_fact:
    expected_config:
      name: Test-Config
      splash_auth_settings: example

Create Group_policies With Merged State

- name: Create group_policies with merged state
  cisco.meraki_rm.meraki_group_policies:
    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 group policies — full resource replacement

Define Replacement Configuration

- name: Define replacement configuration
  ansible.builtin.set_fact:
    expected_config:
      name: Test-Config
      splash_auth_settings: example

Replace Group_policies Configuration

- name: Replace group_policies configuration
  cisco.meraki_rm.meraki_group_policies:
    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 group policies — 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:
      name: Test-Config
      splash_auth_settings: example

Override All Group_policies — Desired State Only

- name: Override all group_policies — desired state only
  cisco.meraki_rm.meraki_group_policies:
    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 group policies — gather current configuration

Gather Current Group_policies Configuration

- name: Gather current group_policies configuration
  cisco.meraki_rm.meraki_group_policies:
    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 group policies — remove configuration

Define Resource To Delete

- name: Define resource to delete
  ansible.builtin.set_fact:
    expected_config:
      name: Test-Config

Delete Group_policies Configuration

- name: Delete group_policies configuration
  cisco.meraki_rm.meraki_group_policies:
    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 group policies — create or update

- name: Define expected configuration
  ansible.builtin.set_fact:
    expected_config:
      name: Test-Config
      splash_auth_settings: example

- name: Create group_policies with merged state
  cisco.meraki_rm.meraki_group_policies:
    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 group policies — full resource replacement

- name: Define replacement configuration
  ansible.builtin.set_fact:
    expected_config:
      name: Test-Config
      splash_auth_settings: example

- name: Replace group_policies configuration
  cisco.meraki_rm.meraki_group_policies:
    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 group policies — override all instances
# Ensures ONLY these resources exist; any not listed are deleted.

- name: Define desired-state configuration
  ansible.builtin.set_fact:
    expected_config:
      name: Test-Config
      splash_auth_settings: example

- name: Override all group_policies — desired state only
  cisco.meraki_rm.meraki_group_policies:
    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 group policies — gather current configuration

- name: Gather current group_policies configuration
  cisco.meraki_rm.meraki_group_policies:
    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 group policies — remove configuration

- name: Define resource to delete
  ansible.builtin.set_fact:
    expected_config:
      name: Test-Config

- name: Delete group_policies configuration
  cisco.meraki_rm.meraki_group_policies:
    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.