cisco.meraki_rm.meraki_appliance

Synopsis Parameters Sample Task Examples Return Values

Synopsis

Manage Meraki appliance ports for a network.
Read/update only (ports exist by default, no create/delete).
Supports merged, replaced, and gathered states.

Author

Cisco Meraki

Parameters

▶ config (list/dict)

List of port configurations.

access_policy (str)

Access policy name (access ports only).

allowed_vlans (str)

Allowed VLANs (comma-delimited or 'all').

drop_untagged_traffic (bool)

Drop untagged traffic (trunk ports).

enabled (bool)

Whether the port is enabled.

port_id (str)

Port ID (e.g., 1, 2, 3, 4). Required for merged, replaced.

type (str)

accesstrunk

Port type (access or trunk).

vlan (int)

Native VLAN (trunk) or access VLAN.

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 Port task
  cisco.meraki_rm.meraki_appliance_port:
    network_id: "192.168.1.0/24"
    config:
      - access_policy: "access_policy_value"
        allowed_vlans: 100
        drop_untagged_traffic: true
        enabled: true
        port_id: 22
        type: access
        vlan: 0
    state: merged

- name: Meraki Appliance Port task
  cisco.meraki_rm.meraki_appliance_port:
    network_id: "192.168.1.0/24"
    config:  # optional
      - access_policy: "access_policy_value"  # optional
        allowed_vlans: 100  # optional
        drop_untagged_traffic: true  # optional
        enabled: true  # optional
        port_id: 22  # optional
        type: access  # optional
        vlan: 0  # optional
    state: merged  # optional

- name: Meraki Appliance Port task
  cisco.meraki_rm.meraki_appliance_port:
    network_id: "192.168.1.0/24"  # (str, required) The network ID.
    config:  # (list, optional) List of port configurations.
      - access_policy: "access_policy_value"  # (str, optional) Access policy name (access ports only).
        allowed_vlans: 100  # (str, optional) Allowed VLANs (comma-delimited or 'all').
        drop_untagged_traffic: true  # (bool, optional) Drop untagged traffic (trunk ports).
        enabled: true  # (bool, optional) Whether the port is enabled.
        port_id: 22  # (str, optional) Port ID (e.g., 1, 2, 3, 4). Required for merged, replaced.
        type: access  # (str, optional) Port type (access or trunk).
        vlan: 0  # (int, optional) Native VLAN (trunk) or access VLAN.
    state: merged  # (str, optional) The state of the resource.

Examples

Define Expected Configuration

- name: Define expected configuration
  ansible.builtin.set_fact:
    expected_config:
      port_id: "1"
      enabled: true
      type: access
      vlan: 1
      allowed_vlans: all
      access_policy: example
      drop_untagged_traffic: true

Create Appliance_port With Merged State

- name: Create appliance_port with merged state
  cisco.meraki_rm.meraki_appliance_port:
    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 ports — full resource replacement

Define Replacement Configuration

- name: Define replacement configuration
  ansible.builtin.set_fact:
    expected_config:
      port_id: "1"
      enabled: false
      type: trunk
      vlan: 20
      allowed_vlans: all
      access_policy: example
      drop_untagged_traffic: true

Replace Appliance_port Configuration

- name: Replace appliance_port configuration
  cisco.meraki_rm.meraki_appliance_port:
    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 ports — gather current configuration

Gather Current Appliance_port Configuration

- name: Gather current appliance_port configuration
  cisco.meraki_rm.meraki_appliance_port:
    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 ports — create or update

- name: Define expected configuration
  ansible.builtin.set_fact:
    expected_config:
      port_id: "1"
      enabled: true
      type: access
      vlan: 1
      allowed_vlans: all
      access_policy: example
      drop_untagged_traffic: true

- name: Create appliance_port with merged state
  cisco.meraki_rm.meraki_appliance_port:
    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 ports — full resource replacement

- name: Define replacement configuration
  ansible.builtin.set_fact:
    expected_config:
      port_id: "1"
      enabled: false
      type: trunk
      vlan: 20
      allowed_vlans: all
      access_policy: example
      drop_untagged_traffic: true

- name: Replace appliance_port configuration
  cisco.meraki_rm.meraki_appliance_port:
    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 ports — gather current configuration

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