100%
cisco.meraki_rm › module › meraki_device_management_interface

meraki_device_management_interface

module
Manage Meraki device management interface
Added in version 0.1.0
Synopsis Parameters Sample Task Examples Return Values

Synopsis

  • Manage Meraki device management interface (singleton per device).
  • Supports merged, replaced, and gathered states.

Author

Cisco Meraki

Parameters

▶ config (list/dict)

Management interface configuration (singleton).

ddns_hostnames (dict)

Dynamic DNS hostnames.

wan1 (dict)

WAN 1 settings.

wan2 (dict)

WAN 2 settings (MX devices only).

serial (str) required

Device serial number.

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 Device Management Interface task
  cisco.meraki_rm.meraki_device_management_interface:
    serial: "serial_value"
    config:
      - ddns_hostnames: {}
        wan1: {}
        wan2: {}
    state: merged
- name: Meraki Device Management Interface task
  cisco.meraki_rm.meraki_device_management_interface:
    serial: "serial_value"
    config:  # optional
      - ddns_hostnames: {}  # optional
        wan1: {}  # optional
        wan2: {}  # optional
    state: merged  # optional
- name: Meraki Device Management Interface task
  cisco.meraki_rm.meraki_device_management_interface:
    serial: "serial_value"  # (str, required) Device serial number.
    config:  # (list, optional) Management interface configuration (singleton).
      - ddns_hostnames: {}  # (dict, optional) Dynamic DNS hostnames.
        wan1: {}  # (dict, optional) WAN 1 settings.
        wan2: {}  # (dict, optional) WAN 2 settings (MX devices only).
    state: merged  # (str, optional) The state of the resource.

Examples

Define Expected Configuration 
- name: Define expected configuration
  ansible.builtin.set_fact:
    expected_config:
Create Device_management_interface With Merged State 
- name: Create device_management_interface with merged state
  cisco.meraki_rm.meraki_device_management_interface:
    serial: "Q2XX-XXXX-XXXX"
    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 device management interface — full resource replacement
Define Replacement Configuration 
- name: Define replacement configuration
  ansible.builtin.set_fact:
    expected_config:
Replace Device_management_interface Configuration 
- name: Replace device_management_interface configuration
  cisco.meraki_rm.meraki_device_management_interface:
    serial: "Q2XX-XXXX-XXXX"
    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 device management interface — gather current configuration
Gather Current Device_management_interface Configuration 
- name: Gather current device_management_interface configuration
  cisco.meraki_rm.meraki_device_management_interface:
    serial: "Q2XX-XXXX-XXXX"
    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 device management interface — create or update

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

- name: Create device_management_interface with merged state
  cisco.meraki_rm.meraki_device_management_interface:
    serial: "Q2XX-XXXX-XXXX"
    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 device management interface — full resource replacement

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

- name: Replace device_management_interface configuration
  cisco.meraki_rm.meraki_device_management_interface:
    serial: "Q2XX-XXXX-XXXX"
    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 device management interface — gather current configuration

- name: Gather current device_management_interface configuration
  cisco.meraki_rm.meraki_device_management_interface:
    serial: "Q2XX-XXXX-XXXX"
    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.