cisco.meraki_rm.meraki_floor

Synopsis Parameters Sample Task Notes Examples Return Values

Synopsis

Manage Meraki floor plans for a network.
Supports merged, replaced, deleted, and gathered states.

Author

Cisco Meraki

Parameters

▶ config (list/dict)

List of floor plan configurations.

bottom_left_corner (dict)

Bottom left corner coordinates.

bottom_right_corner (dict)

Bottom right corner coordinates.

center (dict)

Center coordinates (lat/lng) of the floor plan.

floor_number (float)

Floor number within the building.

floor_plan_id (str)

Server-assigned ID, resolved automatically by matching on name.

Provide only to disambiguate when duplicate names exist.

height (float)

Height of the floor plan.

image_contents (str)

Base64 encoded floor plan image.

image_extension (str)

Image format (e.g., png, jpg).

name (str)

Name of the floor plan.

top_left_corner (dict)

Top left corner coordinates.

top_right_corner (dict)

Top right corner coordinates.

width (float)

Width of the floor plan.

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 Floor Plans task
  cisco.meraki_rm.meraki_floor_plans:
    network_id: "192.168.1.0/24"
    config:
      - bottom_left_corner: {}
        bottom_right_corner: {}
        center: {}
        floor_number: 0.0
        floor_plan_id: "floor_plan_id_value"
        height: 0.0
        image_contents: "example content"
        image_extension: "image_extension_value"
        name: "example_name"
        top_left_corner: {}
        top_right_corner: {}
        width: 0.0
    state: merged

- name: Meraki Floor Plans task
  cisco.meraki_rm.meraki_floor_plans:
    network_id: "192.168.1.0/24"
    config:  # optional
      - bottom_left_corner: {}  # optional
        bottom_right_corner: {}  # optional
        center: {}  # optional
        floor_number: 0.0  # optional
        floor_plan_id: "floor_plan_id_value"  # optional
        height: 0.0  # optional
        image_contents: "example content"  # optional
        image_extension: "image_extension_value"  # optional
        name: "example_name"  # optional
        top_left_corner: {}  # optional
        top_right_corner: {}  # optional
        width: 0.0  # optional
    state: merged  # optional

- name: Meraki Floor Plans task
  cisco.meraki_rm.meraki_floor_plans:
    network_id: "192.168.1.0/24"  # (str, required) The network ID.
    config:  # (list, optional) List of floor plan configurations.
      - bottom_left_corner: {}  # (dict, optional) Bottom left corner coordinates.
        bottom_right_corner: {}  # (dict, optional) Bottom right corner coordinates.
        center: {}  # (dict, optional) Center coordinates (lat/lng) of the floor plan.
        floor_number: 0.0  # (float, optional) Floor number within the building.
        floor_plan_id: "floor_plan_id_value"  # (str, optional) Server-assigned ID, resolved automatically by matching on...
        height: 0.0  # (float, optional) Height of the floor plan.
        image_contents: "example content"  # (str, optional) Base64 encoded floor plan image.
        image_extension: "image_extension_value"  # (str, optional) Image format (e.g., png, jpg).
        name: "example_name"  # (str, optional) Name of the floor plan.
        top_left_corner: {}  # (dict, optional) Top left corner coordinates.
        top_right_corner: {}  # (dict, optional) Top right corner coordinates.
        width: 0.0  # (float, optional) Width of the floor plan.
    state: merged  # (str, optional) The state of the resource.

Notes

Canonical key: name — identifies the resource in playbooks.
System key: floor_plan_id — server-assigned, resolved automatically from gathered state.
Users do not need to provide floor_plan_id unless disambiguating duplicate names.

Examples

Define Expected Configuration

- name: Define expected configuration
  ansible.builtin.set_fact:
    expected_config:
      name: Test-Config
      width: 0.0
      height: 0.0
      floor_number: 0.0
      image_contents: example
      image_extension: example

Create Floor_plans With Merged State

- name: Create floor_plans with merged state
  cisco.meraki_rm.meraki_floor_plans:
    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 floor plans — full resource replacement

Define Replacement Configuration

- name: Define replacement configuration
  ansible.builtin.set_fact:
    expected_config:
      name: Test-Config
      width: 0.0
      height: 0.0
      floor_number: 0.0
      image_contents: example
      image_extension: example

Replace Floor_plans Configuration

- name: Replace floor_plans configuration
  cisco.meraki_rm.meraki_floor_plans:
    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 floor plans — 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:
      name: Test-Config
      width: 0.0
      height: 0.0
      floor_number: 0.0
      image_contents: example
      image_extension: example

Override All Floor_plans — Desired State Only

- name: Override all floor_plans — desired state only
  cisco.meraki_rm.meraki_floor_plans:
    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 floor plans — gather current configuration

Gather Current Floor_plans Configuration

- name: Gather current floor_plans configuration
  cisco.meraki_rm.meraki_floor_plans:
    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 floor plans — remove configuration

Define Resource To Delete

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

Delete Floor_plans Configuration

- name: Delete floor_plans configuration
  cisco.meraki_rm.meraki_floor_plans:
    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 floor plans — create or update

- name: Define expected configuration
  ansible.builtin.set_fact:
    expected_config:
      name: Test-Config
      width: 0.0
      height: 0.0
      floor_number: 0.0
      image_contents: example
      image_extension: example

- name: Create floor_plans with merged state
  cisco.meraki_rm.meraki_floor_plans:
    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 floor plans — full resource replacement

- name: Define replacement configuration
  ansible.builtin.set_fact:
    expected_config:
      name: Test-Config
      width: 0.0
      height: 0.0
      floor_number: 0.0
      image_contents: example
      image_extension: example

- name: Replace floor_plans configuration
  cisco.meraki_rm.meraki_floor_plans:
    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 floor plans — 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: Test-Config
      width: 0.0
      height: 0.0
      floor_number: 0.0
      image_contents: example
      image_extension: example

- name: Override all floor_plans — desired state only
  cisco.meraki_rm.meraki_floor_plans:
    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 floor plans — gather current configuration

- name: Gather current floor_plans configuration
  cisco.meraki_rm.meraki_floor_plans:
    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 floor plans — remove configuration

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

- name: Delete floor_plans configuration
  cisco.meraki_rm.meraki_floor_plans:
    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.