cisco.meraki_rm.meraki_appliance

Synopsis Parameters Sample Task Notes Examples Return Values

Synopsis

Manage Meraki appliance static delegated IPv6 prefixes for a network.
Supports merged, replaced, deleted, and gathered states.

Author

Cisco Meraki

Parameters

▶ config (list/dict)

List of prefix configurations.

description (str)

Identifying description for the prefix.

origin (dict)

WAN1/WAN2/Independent prefix configuration.

prefix (str)

IPv6 prefix/prefix length.

static_delegated_prefix_id (str)

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

Provide only to disambiguate when duplicate prefixes exist.

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 Appliance Prefixes task
  cisco.meraki_rm.meraki_appliance_prefixes:
    network_id: "192.168.1.0/24"
    config:
      - description: "192.168.1.1"
        origin: {}
        prefix: "prefix_value"
        static_delegated_prefix_id: "static_delegated_prefix_id_value"
    state: merged

- name: Meraki Appliance Prefixes task
  cisco.meraki_rm.meraki_appliance_prefixes:
    network_id: "192.168.1.0/24"
    config:  # optional
      - description: "192.168.1.1"  # optional
        origin: {}  # optional
        prefix: "prefix_value"  # optional
        static_delegated_prefix_id: "static_delegated_prefix_id_value"  # optional
    state: merged  # optional

- name: Meraki Appliance Prefixes task
  cisco.meraki_rm.meraki_appliance_prefixes:
    network_id: "192.168.1.0/24"  # (str, required) The network ID.
    config:  # (list, optional) List of prefix configurations.
      - description: "192.168.1.1"  # (str, optional) Identifying description for the prefix.
        origin: {}  # (dict, optional) WAN1/WAN2/Independent prefix configuration.
        prefix: "prefix_value"  # (str, optional) IPv6 prefix/prefix length.
        static_delegated_prefix_id: "static_delegated_prefix_id_value"  # (str, optional) Server-assigned ID, resolved automatically by matching on...
    state: merged  # (str, optional) The state of the resource.

Notes

Canonical key: prefix — the IPv6 prefix string identifies the resource in playbooks.
System key: static_delegated_prefix_id — server-assigned, resolved automatically from gathered state.
Users do not need to provide static_delegated_prefix_id unless disambiguating duplicate prefixes.

Examples

Define Expected Configuration

- name: Define expected configuration
  ansible.builtin.set_fact:
    expected_config:
      prefix: example
      description: Managed by Ansible

Create Appliance_prefixes With Merged State

- name: Create appliance_prefixes with merged state
  cisco.meraki_rm.meraki_appliance_prefixes:
    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 delegated IPv6 prefixes — full resource replacement

Define Replacement Configuration

- name: Define replacement configuration
  ansible.builtin.set_fact:
    expected_config:
      prefix: example
      description: Replaced by Ansible

Replace Appliance_prefixes Configuration

- name: Replace appliance_prefixes configuration
  cisco.meraki_rm.meraki_appliance_prefixes:
    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 delegated IPv6 prefixes — 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:
      prefix: example
      description: Replaced by Ansible

Override All Appliance_prefixes — Desired State Only

- name: Override all appliance_prefixes — desired state only
  cisco.meraki_rm.meraki_appliance_prefixes:
    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 appliance delegated IPv6 prefixes — gather current configuration

Gather Current Appliance_prefixes Configuration

- name: Gather current appliance_prefixes configuration
  cisco.meraki_rm.meraki_appliance_prefixes:
    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 appliance delegated IPv6 prefixes — remove configuration

Define Resource To Delete

- name: Define resource to delete
  ansible.builtin.set_fact:
    expected_config:
      prefix: example

Delete Appliance_prefixes Configuration

- name: Delete appliance_prefixes configuration
  cisco.meraki_rm.meraki_appliance_prefixes:
    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 appliance delegated IPv6 prefixes — create or update

- name: Define expected configuration
  ansible.builtin.set_fact:
    expected_config:
      prefix: example
      description: Managed by Ansible

- name: Create appliance_prefixes with merged state
  cisco.meraki_rm.meraki_appliance_prefixes:
    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 delegated IPv6 prefixes — full resource replacement

- name: Define replacement configuration
  ansible.builtin.set_fact:
    expected_config:
      prefix: example
      description: Replaced by Ansible

- name: Replace appliance_prefixes configuration
  cisco.meraki_rm.meraki_appliance_prefixes:
    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 delegated IPv6 prefixes — override all instances
# Ensures ONLY these resources exist; any not listed are deleted.

- name: Define desired-state configuration
  ansible.builtin.set_fact:
    expected_config:
      prefix: example
      description: Replaced by Ansible

- name: Override all appliance_prefixes — desired state only
  cisco.meraki_rm.meraki_appliance_prefixes:
    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 appliance delegated IPv6 prefixes — gather current configuration

- name: Gather current appliance_prefixes configuration
  cisco.meraki_rm.meraki_appliance_prefixes:
    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 appliance delegated IPv6 prefixes — remove configuration

- name: Define resource to delete
  ansible.builtin.set_fact:
    expected_config:
      prefix: example

- name: Delete appliance_prefixes configuration
  cisco.meraki_rm.meraki_appliance_prefixes:
    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.