cisco.meraki_rm.meraki_switch_dhcp

Synopsis Parameters Sample Task Examples Return Values

Synopsis

Manage Meraki switch DHCP server policy for a network.
Singleton per network (GET/PUT settings).
Supports merged, replaced, and gathered states.

Author

Cisco Meraki

Parameters

▶ config (list/dict)

DHCP policy configuration (singleton).

alerts (dict)

Email alert settings for DHCP servers.

allowed_servers (list/str)

MAC addresses of DHCP servers to permit.

always_allowed_servers (list/str)

MAC addresses always allowed on the network.

arp_inspection (dict)

Dynamic ARP Inspection settings.

blocked_servers (list/str)

MAC addresses of DHCP servers to block.

default_policy (str)

Default policy for new DHCP servers (allow or block).

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 Switch Dhcp Policy task
  cisco.meraki_rm.meraki_switch_dhcp_policy:
    network_id: "192.168.1.0/24"
    config:
      - alerts: {}
        allowed_servers:
          - "allowed_servers_item"
        always_allowed_servers:
          - "always_allowed_servers_item"
        arp_inspection: {}
        blocked_servers:
          - "blocked_servers_item"
        default_policy: "default_policy_value"
    state: merged

- name: Meraki Switch Dhcp Policy task
  cisco.meraki_rm.meraki_switch_dhcp_policy:
    network_id: "192.168.1.0/24"
    config:  # optional
      - alerts: {}  # optional
        allowed_servers:  # optional
          - "allowed_servers_item"
        always_allowed_servers:  # optional
          - "always_allowed_servers_item"
        arp_inspection: {}  # optional
        blocked_servers:  # optional
          - "blocked_servers_item"
        default_policy: "default_policy_value"  # optional
    state: merged  # optional

- name: Meraki Switch Dhcp Policy task
  cisco.meraki_rm.meraki_switch_dhcp_policy:
    network_id: "192.168.1.0/24"  # (str, required) The network ID.
    config:  # (list, optional) DHCP policy configuration (singleton).
      - alerts: {}  # (dict, optional) Email alert settings for DHCP servers.
        allowed_servers:  # (list, optional) MAC addresses of DHCP servers to permit.
          - "allowed_servers_item"
        always_allowed_servers:  # (list, optional) MAC addresses always allowed on the network.
          - "always_allowed_servers_item"
        arp_inspection: {}  # (dict, optional) Dynamic ARP Inspection settings.
        blocked_servers:  # (list, optional) MAC addresses of DHCP servers to block.
          - "blocked_servers_item"
        default_policy: "default_policy_value"  # (str, optional) Default policy for new DHCP servers (allow or block).
    state: merged  # (str, optional) The state of the resource.

Examples

Define Expected Configuration

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

Create Switch_dhcp_policy With Merged State

- name: Create switch_dhcp_policy with merged state
  cisco.meraki_rm.meraki_switch_dhcp_policy:
    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 DHCP server policy — full resource replacement

Define Replacement Configuration

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

Replace Switch_dhcp_policy Configuration

- name: Replace switch_dhcp_policy configuration
  cisco.meraki_rm.meraki_switch_dhcp_policy:
    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 DHCP server policy — gather current configuration

Gather Current Switch_dhcp_policy Configuration

- name: Gather current switch_dhcp_policy configuration
  cisco.meraki_rm.meraki_switch_dhcp_policy:
    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 switch DHCP server policy — create or update

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

- name: Create switch_dhcp_policy with merged state
  cisco.meraki_rm.meraki_switch_dhcp_policy:
    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 DHCP server policy — full resource replacement

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

- name: Replace switch_dhcp_policy configuration
  cisco.meraki_rm.meraki_switch_dhcp_policy:
    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 DHCP server policy — gather current configuration

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