cisco.meraki_rm.meraki_appliance

Synopsis Parameters Sample Task Examples Return Values

Synopsis

Manage Meraki appliance security (intrusion detection, malware) for a network.
Singleton per network (update only, no create/delete).
Supports merged, replaced, and gathered states.

Author

Cisco Meraki

Parameters

▶ config (list/dict)

Security configuration (singleton).

allowed_files (list/dict)

Sha256 digests of files permitted by malware engine.

allowed_urls (list/dict)

URLs permitted by malware detection engine.

ids_rulesets (str)

Intrusion detection ruleset.

mode (str)

Intrusion detection mode.

protected_networks (dict)

Networks included/excluded from detection.

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 Appliance Security task
  cisco.meraki_rm.meraki_appliance_security:
    network_id: "192.168.1.0/24"
    config:
      - allowed_files:
          - {}
        allowed_urls:
          - {}
        ids_rulesets: "ids_rulesets_value"
        mode: "0644"
        protected_networks: {}
    state: merged

- name: Meraki Appliance Security task
  cisco.meraki_rm.meraki_appliance_security:
    network_id: "192.168.1.0/24"
    config:  # optional
      - allowed_files:  # optional
          - {}
        allowed_urls:  # optional
          - {}
        ids_rulesets: "ids_rulesets_value"  # optional
        mode: "0644"  # optional
        protected_networks: {}  # optional
    state: merged  # optional

- name: Meraki Appliance Security task
  cisco.meraki_rm.meraki_appliance_security:
    network_id: "192.168.1.0/24"  # (str, required) The network ID.
    config:  # (list, optional) Security configuration (singleton).
      - allowed_files:  # (list, optional) Sha256 digests of files permitted by malware engine.
          - {}
        allowed_urls:  # (list, optional) URLs permitted by malware detection engine.
          - {}
        ids_rulesets: "ids_rulesets_value"  # (str, optional) Intrusion detection ruleset.
        mode: "0644"  # (str, optional) Intrusion detection mode.
        protected_networks: {}  # (dict, optional) Networks included/excluded from detection.
    state: merged  # (str, optional) The state of the resource.

Examples

Define Expected Configuration

- name: Define expected configuration
  ansible.builtin.set_fact:
    expected_config:
      mode: none
      ids_rulesets: example

Create Appliance_security With Merged State

- name: Create appliance_security with merged state
  cisco.meraki_rm.meraki_appliance_security:
    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 appliance security settings — full resource replacement

Define Replacement Configuration

- name: Define replacement configuration
  ansible.builtin.set_fact:
    expected_config:
      mode: spoke
      ids_rulesets: example

Replace Appliance_security Configuration

- name: Replace appliance_security configuration
  cisco.meraki_rm.meraki_appliance_security:
    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 appliance security settings — gather current configuration

Gather Current Appliance_security Configuration

- name: Gather current appliance_security configuration
  cisco.meraki_rm.meraki_appliance_security:
    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 appliance security settings — create or update

- name: Define expected configuration
  ansible.builtin.set_fact:
    expected_config:
      mode: none
      ids_rulesets: example

- name: Create appliance_security with merged state
  cisco.meraki_rm.meraki_appliance_security:
    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 appliance security settings — full resource replacement

- name: Define replacement configuration
  ansible.builtin.set_fact:
    expected_config:
      mode: spoke
      ids_rulesets: example

- name: Replace appliance_security configuration
  cisco.meraki_rm.meraki_appliance_security:
    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 appliance security settings — gather current configuration

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