cisco.meraki_rm.meraki_vlan

Synopsis Parameters Sample Task Notes Examples Return Values

Synopsis

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

Author

Cisco Meraki

Parameters

▶ config (list/dict)

List of VLAN profile configurations.

iname (str)

VLAN profile iname (primary key). Required for merged, replaced, deleted.

is_default (bool)

Whether this is the default VLAN profile.

name (str)

Name of the profile (1-255 chars).

vlan_groups (list/dict)

Array of named VLAN groups.

vlan_names (list/dict)

Array of named VLANs.

vlan_profile (dict)

VLAN profile configuration.

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 Vlan Profiles task
  cisco.meraki_rm.meraki_vlan_profiles:
    network_id: "192.168.1.0/24"
    config:
      - iname: "example_name"
        is_default: true
        name: "example_name"
        vlan_groups:
          - {}
        vlan_names:
          - {}
        vlan_profile: {}
    state: merged

- name: Meraki Vlan Profiles task
  cisco.meraki_rm.meraki_vlan_profiles:
    network_id: "192.168.1.0/24"
    config:  # optional
      - iname: "example_name"  # optional
        is_default: true  # optional
        name: "example_name"  # optional
        vlan_groups:  # optional
          - {}
        vlan_names:  # optional
          - {}
        vlan_profile: {}  # optional
    state: merged  # optional

- name: Meraki Vlan Profiles task
  cisco.meraki_rm.meraki_vlan_profiles:
    network_id: "192.168.1.0/24"  # (str, required) The network ID.
    config:  # (list, optional) List of VLAN profile configurations.
      - iname: "example_name"  # (str, optional) VLAN profile iname (primary key). Required for merged, re...
        is_default: true  # (bool, optional) Whether this is the default VLAN profile.
        name: "example_name"  # (str, optional) Name of the profile (1-255 chars).
        vlan_groups:  # (list, optional) Array of named VLAN groups.
          - {}
        vlan_names:  # (list, optional) Array of named VLANs.
          - {}
        vlan_profile: {}  # (dict, optional) VLAN profile configuration.
    state: merged  # (str, optional) The state of the resource.

Notes

Canonical key: iname — user-assigned identifier, used for both identification and API routing.

Examples

Define Expected Configuration

- name: Define expected configuration
  ansible.builtin.set_fact:
    expected_config:
      iname: example
      name: Test-Config
      is_default: true

Create Vlan_profiles With Merged State

- name: Create vlan_profiles with merged state
  cisco.meraki_rm.meraki_vlan_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 VLAN profiles — full resource replacement

Define Replacement Configuration

- name: Define replacement configuration
  ansible.builtin.set_fact:
    expected_config:
      iname: example
      name: Replaced-Config
      is_default: true

Replace Vlan_profiles Configuration

- name: Replace vlan_profiles configuration
  cisco.meraki_rm.meraki_vlan_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 VLAN 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:
      iname: example
      name: Replaced-Config
      is_default: true

Override All Vlan_profiles — Desired State Only

- name: Override all vlan_profiles — desired state only
  cisco.meraki_rm.meraki_vlan_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 VLAN profiles — gather current configuration

Gather Current Vlan_profiles Configuration

- name: Gather current vlan_profiles configuration
  cisco.meraki_rm.meraki_vlan_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 VLAN profiles — remove configuration

Define Resource To Delete

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

Delete Vlan_profiles Configuration

- name: Delete vlan_profiles configuration
  cisco.meraki_rm.meraki_vlan_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 VLAN profiles — create or update

- name: Define expected configuration
  ansible.builtin.set_fact:
    expected_config:
      iname: example
      name: Test-Config
      is_default: true

- name: Create vlan_profiles with merged state
  cisco.meraki_rm.meraki_vlan_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 VLAN profiles — full resource replacement

- name: Define replacement configuration
  ansible.builtin.set_fact:
    expected_config:
      iname: example
      name: Replaced-Config
      is_default: true

- name: Replace vlan_profiles configuration
  cisco.meraki_rm.meraki_vlan_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 VLAN 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:
      iname: example
      name: Replaced-Config
      is_default: true

- name: Override all vlan_profiles — desired state only
  cisco.meraki_rm.meraki_vlan_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 VLAN profiles — gather current configuration

- name: Gather current vlan_profiles configuration
  cisco.meraki_rm.meraki_vlan_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 VLAN profiles — remove configuration

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

- name: Delete vlan_profiles configuration
  cisco.meraki_rm.meraki_vlan_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.