cisco.meraki_rm.meraki_network

Synopsis Parameters Sample Task Examples Return Values

Synopsis

Manage Meraki network settings (singleton per network).
Supports merged, replaced, and gathered states.

Author

Cisco Meraki

Parameters

▶ config (list/dict)

Network settings configuration (singleton).

custom_pie_chart_items (list/dict)

Custom pie chart items for traffic reporting.

fips (dict)

FIPS options for the network.

local_status_page (dict)

Local status page authentication options.

local_status_page_enabled (bool)

Enable local device status pages.

mode (str)

Traffic analysis mode.

named_vlans (dict)

Named VLANs options.

remote_status_page_enabled (bool)

Enable access to device status page via LAN IP.

reporting_enabled (bool)

Enable NetFlow traffic reporting.

secure_port (dict)

SecureConnect options.

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 Network Settings task
  cisco.meraki_rm.meraki_network_settings:
    network_id: "192.168.1.0/24"
    config:
      - custom_pie_chart_items:
          - {}
        fips: {}
        local_status_page: {}
        local_status_page_enabled: true
        mode: "0644"
        named_vlans: {}
        remote_status_page_enabled: true
        reporting_enabled: true
        secure_port: {}
    state: merged

- name: Meraki Network Settings task
  cisco.meraki_rm.meraki_network_settings:
    network_id: "192.168.1.0/24"
    config:  # optional
      - custom_pie_chart_items:  # optional
          - {}
        fips: {}  # optional
        local_status_page: {}  # optional
        local_status_page_enabled: true  # optional
        mode: "0644"  # optional
        named_vlans: {}  # optional
        remote_status_page_enabled: true  # optional
        reporting_enabled: true  # optional
        secure_port: {}  # optional
    state: merged  # optional

- name: Meraki Network Settings task
  cisco.meraki_rm.meraki_network_settings:
    network_id: "192.168.1.0/24"  # (str, required) The network ID.
    config:  # (list, optional) Network settings configuration (singleton).
      - custom_pie_chart_items:  # (list, optional) Custom pie chart items for traffic reporting.
          - {}
        fips: {}  # (dict, optional) FIPS options for the network.
        local_status_page: {}  # (dict, optional) Local status page authentication options.
        local_status_page_enabled: true  # (bool, optional) Enable local device status pages.
        mode: "0644"  # (str, optional) Traffic analysis mode.
        named_vlans: {}  # (dict, optional) Named VLANs options.
        remote_status_page_enabled: true  # (bool, optional) Enable access to device status page via LAN IP.
        reporting_enabled: true  # (bool, optional) Enable NetFlow traffic reporting.
        secure_port: {}  # (dict, optional) SecureConnect options.
    state: merged  # (str, optional) The state of the resource.

Examples

Define Expected Configuration

- name: Define expected configuration
  ansible.builtin.set_fact:
    expected_config:
      local_status_page_enabled: true
      remote_status_page_enabled: true
      reporting_enabled: true
      mode: none

Create Network_settings With Merged State

- name: Create network_settings with merged state
  cisco.meraki_rm.meraki_network_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 network settings — full resource replacement

Define Replacement Configuration

- name: Define replacement configuration
  ansible.builtin.set_fact:
    expected_config:
      local_status_page_enabled: true
      remote_status_page_enabled: true
      reporting_enabled: true
      mode: spoke

Replace Network_settings Configuration

- name: Replace network_settings configuration
  cisco.meraki_rm.meraki_network_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 network settings — gather current configuration

Gather Current Network_settings Configuration

- name: Gather current network_settings configuration
  cisco.meraki_rm.meraki_network_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 network settings — create or update

- name: Define expected configuration
  ansible.builtin.set_fact:
    expected_config:
      local_status_page_enabled: true
      remote_status_page_enabled: true
      reporting_enabled: true
      mode: none

- name: Create network_settings with merged state
  cisco.meraki_rm.meraki_network_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 network settings — full resource replacement

- name: Define replacement configuration
  ansible.builtin.set_fact:
    expected_config:
      local_status_page_enabled: true
      remote_status_page_enabled: true
      reporting_enabled: true
      mode: spoke

- name: Replace network_settings configuration
  cisco.meraki_rm.meraki_network_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 network settings — gather current configuration

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