cisco.meraki_rm.meraki_sensor_alert

Synopsis Parameters Sample Task Notes Examples Return Values

Synopsis

Manage Meraki sensor alert profiles for a network.
Supports merged, replaced, deleted, and gathered states.

Author

Cisco Meraki

Parameters

▶ config (list/dict)

List of sensor alert profile configurations.

conditions (list/dict)

List of conditions that trigger alerts.

id (str)

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

Provide only to disambiguate when duplicate names exist.

include_sensor_url (bool)

Include dashboard link to sensor in messages.

message (str)

Custom message for email and text alerts.

name (str)

Name of the sensor alert profile.

recipients (dict)

Recipients that receive alerts.

schedule (dict)

Sensor schedule for the alert profile.

serials (list/str)

Device serials assigned to this profile.

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 Sensor Alert Profiles task
  cisco.meraki_rm.meraki_sensor_alert_profiles:
    network_id: "192.168.1.0/24"
    config:
      - conditions:
          - {}
        id: "id_value"
        include_sensor_url: true
        message: "message_value"
        name: "example_name"
        recipients: {}
        schedule: {}
        serials:
          - "serials_item"
    state: merged

- name: Meraki Sensor Alert Profiles task
  cisco.meraki_rm.meraki_sensor_alert_profiles:
    network_id: "192.168.1.0/24"
    config:  # optional
      - conditions:  # optional
          - {}
        id: "id_value"  # optional
        include_sensor_url: true  # optional
        message: "message_value"  # optional
        name: "example_name"  # optional
        recipients: {}  # optional
        schedule: {}  # optional
        serials:  # optional
          - "serials_item"
    state: merged  # optional

- name: Meraki Sensor Alert Profiles task
  cisco.meraki_rm.meraki_sensor_alert_profiles:
    network_id: "192.168.1.0/24"  # (str, required) The network ID.
    config:  # (list, optional) List of sensor alert profile configurations.
      - conditions:  # (list, optional) List of conditions that trigger alerts.
          - {}
        id: "id_value"  # (str, optional) Server-assigned ID, resolved automatically by matching on...
        include_sensor_url: true  # (bool, optional) Include dashboard link to sensor in messages.
        message: "message_value"  # (str, optional) Custom message for email and text alerts.
        name: "example_name"  # (str, optional) Name of the sensor alert profile.
        recipients: {}  # (dict, optional) Recipients that receive alerts.
        schedule: {}  # (dict, optional) Sensor schedule for the alert profile.
        serials:  # (list, optional) Device serials assigned to this profile.
          - "serials_item"
    state: merged  # (str, optional) The state of the resource.

Notes

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

Examples

Define Expected Configuration

- name: Define expected configuration
  ansible.builtin.set_fact:
    expected_config:
      name: Test-Config
      message: example
      include_sensor_url: true

Create Sensor_alert_profiles With Merged State

- name: Create sensor_alert_profiles with merged state
  cisco.meraki_rm.meraki_sensor_alert_profiles:
    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 sensor alert profiles — full resource replacement

Define Replacement Configuration

- name: Define replacement configuration
  ansible.builtin.set_fact:
    expected_config:
      name: Test-Config
      message: example
      include_sensor_url: true

Replace Sensor_alert_profiles Configuration

- name: Replace sensor_alert_profiles configuration
  cisco.meraki_rm.meraki_sensor_alert_profiles:
    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 sensor alert profiles — 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
      message: example
      include_sensor_url: true

Override All Sensor_alert_profiles — Desired State Only

- name: Override all sensor_alert_profiles — desired state only
  cisco.meraki_rm.meraki_sensor_alert_profiles:
    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 sensor alert profiles — gather current configuration

Gather Current Sensor_alert_profiles Configuration

- name: Gather current sensor_alert_profiles configuration
  cisco.meraki_rm.meraki_sensor_alert_profiles:
    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 sensor alert profiles — remove configuration

Define Resource To Delete

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

Delete Sensor_alert_profiles Configuration

- name: Delete sensor_alert_profiles configuration
  cisco.meraki_rm.meraki_sensor_alert_profiles:
    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 sensor alert profiles — create or update

- name: Define expected configuration
  ansible.builtin.set_fact:
    expected_config:
      name: Test-Config
      message: example
      include_sensor_url: true

- name: Create sensor_alert_profiles with merged state
  cisco.meraki_rm.meraki_sensor_alert_profiles:
    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 sensor alert profiles — full resource replacement

- name: Define replacement configuration
  ansible.builtin.set_fact:
    expected_config:
      name: Test-Config
      message: example
      include_sensor_url: true

- name: Replace sensor_alert_profiles configuration
  cisco.meraki_rm.meraki_sensor_alert_profiles:
    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 sensor alert profiles — 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
      message: example
      include_sensor_url: true

- name: Override all sensor_alert_profiles — desired state only
  cisco.meraki_rm.meraki_sensor_alert_profiles:
    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 sensor alert profiles — gather current configuration

- name: Gather current sensor_alert_profiles configuration
  cisco.meraki_rm.meraki_sensor_alert_profiles:
    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 sensor alert profiles — remove configuration

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

- name: Delete sensor_alert_profiles configuration
  cisco.meraki_rm.meraki_sensor_alert_profiles:
    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.