cisco.meraki_rm.meraki_appliance

Synopsis Parameters Sample Task Examples Return Values

Synopsis

Manage Meraki appliance SSIDs (MX wireless) for a network.
Read/update only (SSIDs 0-4 exist by default, no create/delete).
Supports merged, replaced, and gathered states.

Author

Cisco Meraki

Parameters

▶ config (list/dict)

List of appliance SSID configurations.

auth_mode (str)

Association control method.

default_vlan_id (int)

VLAN ID associated with this SSID.

enabled (bool)

Whether the SSID is enabled.

encryption_mode (str)

PSK encryption mode.

name (str)

Name of the SSID.

number (int)

SSID number (0-4). Required for merged, replaced.

psk (str)

Passkey (auth_mode is psk).

radius_servers (list/dict)

RADIUS 802.1x servers for authentication.

visible (bool)

Whether to advertise or hide this SSID.

wpa_encryption_mode (str)

WPA encryption mode.

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 Ssid task
  cisco.meraki_rm.meraki_appliance_ssid:
    network_id: "192.168.1.0/24"
    config:
      - auth_mode: "0644"
        default_vlan_id: 0
        enabled: true
        encryption_mode: "0644"
        name: "example_name"
        number: 0
        psk: "psk_value"
        radius_servers:
          - {}
        visible: true
        wpa_encryption_mode: "0644"
    state: merged

- name: Meraki Appliance Ssid task
  cisco.meraki_rm.meraki_appliance_ssid:
    network_id: "192.168.1.0/24"
    config:  # optional
      - auth_mode: "0644"  # optional
        default_vlan_id: 0  # optional
        enabled: true  # optional
        encryption_mode: "0644"  # optional
        name: "example_name"  # optional
        number: 0  # optional
        psk: "psk_value"  # optional
        radius_servers:  # optional
          - {}
        visible: true  # optional
        wpa_encryption_mode: "0644"  # optional
    state: merged  # optional

- name: Meraki Appliance Ssid task
  cisco.meraki_rm.meraki_appliance_ssid:
    network_id: "192.168.1.0/24"  # (str, required) The network ID.
    config:  # (list, optional) List of appliance SSID configurations.
      - auth_mode: "0644"  # (str, optional) Association control method.
        default_vlan_id: 0  # (int, optional) VLAN ID associated with this SSID.
        enabled: true  # (bool, optional) Whether the SSID is enabled.
        encryption_mode: "0644"  # (str, optional) PSK encryption mode.
        name: "example_name"  # (str, optional) Name of the SSID.
        number: 0  # (int, optional) SSID number (0-4). Required for merged, replaced.
        psk: "psk_value"  # (str, optional) Passkey (auth_mode is psk).
        radius_servers:  # (list, optional) RADIUS 802.1x servers for authentication.
          - {}
        visible: true  # (bool, optional) Whether to advertise or hide this SSID.
        wpa_encryption_mode: "0644"  # (str, optional) WPA encryption mode.
    state: merged  # (str, optional) The state of the resource.

Examples

Define Expected Configuration

- name: Define expected configuration
  ansible.builtin.set_fact:
    expected_config:
      number: 1
      name: Test-Config
      enabled: true
      auth_mode: open
      encryption_mode: wpa
      psk: testpassword123
      default_vlan_id: 1
      visible: true

Create Appliance_ssid With Merged State

- name: Create appliance_ssid with merged state
  cisco.meraki_rm.meraki_appliance_ssid:
    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 SSIDs — full resource replacement

Define Replacement Configuration

- name: Define replacement configuration
  ansible.builtin.set_fact:
    expected_config:
      number: 1
      name: Replaced-Config
      enabled: false
      auth_mode: open
      encryption_mode: wpa
      psk: testpassword123
      default_vlan_id: 1
      visible: true

Replace Appliance_ssid Configuration

- name: Replace appliance_ssid configuration
  cisco.meraki_rm.meraki_appliance_ssid:
    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 SSIDs — gather current configuration

Gather Current Appliance_ssid Configuration

- name: Gather current appliance_ssid configuration
  cisco.meraki_rm.meraki_appliance_ssid:
    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 SSIDs — create or update

- name: Define expected configuration
  ansible.builtin.set_fact:
    expected_config:
      number: 1
      name: Test-Config
      enabled: true
      auth_mode: open
      encryption_mode: wpa
      psk: testpassword123
      default_vlan_id: 1
      visible: true

- name: Create appliance_ssid with merged state
  cisco.meraki_rm.meraki_appliance_ssid:
    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 SSIDs — full resource replacement

- name: Define replacement configuration
  ansible.builtin.set_fact:
    expected_config:
      number: 1
      name: Replaced-Config
      enabled: false
      auth_mode: open
      encryption_mode: wpa
      psk: testpassword123
      default_vlan_id: 1
      visible: true

- name: Replace appliance_ssid configuration
  cisco.meraki_rm.meraki_appliance_ssid:
    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 SSIDs — gather current configuration

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