cisco.meraki_rm.meraki_appliance_warm

Synopsis Parameters Sample Task Examples Return Values

Synopsis

Manage Meraki appliance warm spare configuration for a network.
Singleton per network (update only, no create/delete).
Supports merged, replaced, and gathered states.

Author

Cisco Meraki

Parameters

▶ config (list/dict)

Warm spare configuration (singleton).

enabled (bool)

Whether warm spare is enabled.

primary_serial (str)

Serial number of the primary appliance.

spare_serial (str)

Serial number of the warm spare appliance.

uplink_mode (str)

Uplink mode (virtual or public).

virtual_ip1 (str)

WAN 1 shared IP.

virtual_ip2 (str)

WAN 2 shared IP.

wan1 (dict)

WAN 1 IP and subnet.

wan2 (dict)

WAN 2 IP and subnet.

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 Warm Spare task
  cisco.meraki_rm.meraki_appliance_warm_spare:
    network_id: "192.168.1.0/24"
    config:
      - enabled: true
        primary_serial: "primary_serial_value"
        spare_serial: "spare_serial_value"
        uplink_mode: "0644"
        virtual_ip1: "192.168.1.1"
        virtual_ip2: "192.168.1.1"
        wan1: {}
        wan2: {}
    state: merged

- name: Meraki Appliance Warm Spare task
  cisco.meraki_rm.meraki_appliance_warm_spare:
    network_id: "192.168.1.0/24"
    config:  # optional
      - enabled: true  # optional
        primary_serial: "primary_serial_value"  # optional
        spare_serial: "spare_serial_value"  # optional
        uplink_mode: "0644"  # optional
        virtual_ip1: "192.168.1.1"  # optional
        virtual_ip2: "192.168.1.1"  # optional
        wan1: {}  # optional
        wan2: {}  # optional
    state: merged  # optional

- name: Meraki Appliance Warm Spare task
  cisco.meraki_rm.meraki_appliance_warm_spare:
    network_id: "192.168.1.0/24"  # (str, required) The network ID.
    config:  # (list, optional) Warm spare configuration (singleton).
      - enabled: true  # (bool, optional) Whether warm spare is enabled.
        primary_serial: "primary_serial_value"  # (str, optional) Serial number of the primary appliance.
        spare_serial: "spare_serial_value"  # (str, optional) Serial number of the warm spare appliance.
        uplink_mode: "0644"  # (str, optional) Uplink mode (virtual or public).
        virtual_ip1: "192.168.1.1"  # (str, optional) WAN 1 shared IP.
        virtual_ip2: "192.168.1.1"  # (str, optional) WAN 2 shared IP.
        wan1: {}  # (dict, optional) WAN 1 IP and subnet.
        wan2: {}  # (dict, optional) WAN 2 IP and subnet.
    state: merged  # (str, optional) The state of the resource.

Examples

Define Expected Configuration

- name: Define expected configuration
  ansible.builtin.set_fact:
    expected_config:
      enabled: true
      spare_serial: Q2XX-SPARE-0001
      uplink_mode: virtual
      virtual_ip1: 10.0.0.2
      virtual_ip2: 10.0.0.3
      primary_serial: example

Create Appliance_warm_spare With Merged State

- name: Create appliance_warm_spare with merged state
  cisco.meraki_rm.meraki_appliance_warm_spare:
    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 warm spare — full resource replacement

Define Replacement Configuration

- name: Define replacement configuration
  ansible.builtin.set_fact:
    expected_config:
      enabled: false
      spare_serial: Q2XX-SPARE-0001
      uplink_mode: virtual
      virtual_ip1: 10.0.0.2
      virtual_ip2: 10.0.0.3
      primary_serial: example

Replace Appliance_warm_spare Configuration

- name: Replace appliance_warm_spare configuration
  cisco.meraki_rm.meraki_appliance_warm_spare:
    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 warm spare — gather current configuration

Gather Current Appliance_warm_spare Configuration

- name: Gather current appliance_warm_spare configuration
  cisco.meraki_rm.meraki_appliance_warm_spare:
    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 warm spare — create or update

- name: Define expected configuration
  ansible.builtin.set_fact:
    expected_config:
      enabled: true
      spare_serial: Q2XX-SPARE-0001
      uplink_mode: virtual
      virtual_ip1: 10.0.0.2
      virtual_ip2: 10.0.0.3
      primary_serial: example

- name: Create appliance_warm_spare with merged state
  cisco.meraki_rm.meraki_appliance_warm_spare:
    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 warm spare — full resource replacement

- name: Define replacement configuration
  ansible.builtin.set_fact:
    expected_config:
      enabled: false
      spare_serial: Q2XX-SPARE-0001
      uplink_mode: virtual
      virtual_ip1: 10.0.0.2
      virtual_ip2: 10.0.0.3
      primary_serial: example

- name: Replace appliance_warm_spare configuration
  cisco.meraki_rm.meraki_appliance_warm_spare:
    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 warm spare — gather current configuration

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