100%
cisco.meraki_rm › module › meraki_switch_link_aggregations

meraki_switch_link_aggregations

module
Manage Meraki switch link aggregations
Added in version 0.1.0
Synopsis Parameters Sample Task Notes Examples Return Values

Synopsis

  • Manage Meraki switch link aggregation groups for a network.
  • Network-scoped. Supports merged, replaced, deleted, and gathered states.

Author

Cisco Meraki

Parameters

▶ config (list/dict)

List of link aggregation configurations.

link_aggregation_id (str)

Server-assigned aggregation ID. Discover via state=gathered.

switch_ports (list/dict)

Array of switch ports for the aggregation.

switch_profile_ports (list/dict)

Array of switch profile ports for creating aggregation.

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 Switch Link Aggregations task
  cisco.meraki_rm.meraki_switch_link_aggregations:
    network_id: "192.168.1.0/24"
    config:
      - link_aggregation_id: "link_aggregation_id_value"
        switch_ports:
          - {}
        switch_profile_ports:
          - {}
    state: merged
- name: Meraki Switch Link Aggregations task
  cisco.meraki_rm.meraki_switch_link_aggregations:
    network_id: "192.168.1.0/24"
    config:  # optional
      - link_aggregation_id: "link_aggregation_id_value"  # optional
        switch_ports:  # optional
          - {}
        switch_profile_ports:  # optional
          - {}
    state: merged  # optional
- name: Meraki Switch Link Aggregations task
  cisco.meraki_rm.meraki_switch_link_aggregations:
    network_id: "192.168.1.0/24"  # (str, required) The network ID.
    config:  # (list, optional) List of link aggregation configurations.
      - link_aggregation_id: "link_aggregation_id_value"  # (str, optional) Server-assigned aggregation ID. Discover via C(state=gath...
        switch_ports:  # (list, optional) Array of switch ports for the aggregation.
          - {}
        switch_profile_ports:  # (list, optional) Array of switch profile ports for creating aggregation.
          - {}
    state: merged  # (str, optional) The state of the resource.

Notes

  • This resource has no canonical key (Category C — gather-first).
  • Use state=gathered to discover link_aggregation_id values, then reference them in subsequent tasks.

Examples

Define Expected Configuration 
- name: Define expected configuration
  ansible.builtin.set_fact:
    expected_config:
Create Switch_link_aggregations With Merged State 
- name: Create switch_link_aggregations with merged state
  cisco.meraki_rm.meraki_switch_link_aggregations:
    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 switch link aggregations — full resource replacement
Define Replacement Configuration 
- name: Define replacement configuration
  ansible.builtin.set_fact:
    expected_config:
Replace Switch_link_aggregations Configuration 
- name: Replace switch_link_aggregations configuration
  cisco.meraki_rm.meraki_switch_link_aggregations:
    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 switch link aggregations — 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:
Override All Switch_link_aggregations — Desired State Only 
- name: Override all switch_link_aggregations — desired state only
  cisco.meraki_rm.meraki_switch_link_aggregations:
    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 switch link aggregations — gather current configuration
Gather Current Switch_link_aggregations Configuration 
- name: Gather current switch_link_aggregations configuration
  cisco.meraki_rm.meraki_switch_link_aggregations:
    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 switch link aggregations — remove configuration
Define Resource To Delete 
- name: Define resource to delete
  ansible.builtin.set_fact:
    expected_config:
Delete Switch_link_aggregations Configuration 
- name: Delete switch_link_aggregations configuration
  cisco.meraki_rm.meraki_switch_link_aggregations:
    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 switch link aggregations — create or update

- name: Define expected configuration
  ansible.builtin.set_fact:
    expected_config:

- name: Create switch_link_aggregations with merged state
  cisco.meraki_rm.meraki_switch_link_aggregations:
    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 switch link aggregations — full resource replacement

- name: Define replacement configuration
  ansible.builtin.set_fact:
    expected_config:

- name: Replace switch_link_aggregations configuration
  cisco.meraki_rm.meraki_switch_link_aggregations:
    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 switch link aggregations — override all instances
# Ensures ONLY these resources exist; any not listed are deleted.

- name: Define desired-state configuration
  ansible.builtin.set_fact:
    expected_config:

- name: Override all switch_link_aggregations — desired state only
  cisco.meraki_rm.meraki_switch_link_aggregations:
    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 switch link aggregations — gather current configuration

- name: Gather current switch_link_aggregations configuration
  cisco.meraki_rm.meraki_switch_link_aggregations:
    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 switch link aggregations — remove configuration

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

- name: Delete switch_link_aggregations configuration
  cisco.meraki_rm.meraki_switch_link_aggregations:
    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.