cisco.meraki_rm.meraki_appliance_static

Synopsis Parameters Sample Task Notes Examples Return Values

Synopsis

Manage Meraki appliance static routes for a network.
Supports merged, replaced, deleted, and gathered states.

Author

Cisco Meraki

Parameters

▶ config (list/dict)

List of static route configurations.

enabled (bool)

Whether the route is enabled.

fixed_ip_assignments (dict)

Fixed DHCP IP assignments on the route.

gateway_ip (str)

Gateway IP address (next hop).

gateway_vlan_id (int)

Gateway VLAN ID.

ip_version (int)

IP protocol version (4 or 6).

name (str)

Name of the route.

reserved_ip_ranges (list/dict)

DHCP reserved IP ranges.

static_route_id (str)

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

Provide only to disambiguate when duplicate names exist.

subnet (str)

Subnet of the route (e.g., 192.168.1.0/24).

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 Appliance Static Routes task
  cisco.meraki_rm.meraki_appliance_static_routes:
    network_id: "192.168.1.0/24"
    config:
      - enabled: true
        fixed_ip_assignments: {}
        gateway_ip: "192.168.1.1"
        gateway_vlan_id: 0
        ip_version: 0
        name: "example_name"
        reserved_ip_ranges:
          - {}
        static_route_id: "static_route_id_value"
        subnet: "192.168.1.0/24"
    state: merged

- name: Meraki Appliance Static Routes task
  cisco.meraki_rm.meraki_appliance_static_routes:
    network_id: "192.168.1.0/24"
    config:  # optional
      - enabled: true  # optional
        fixed_ip_assignments: {}  # optional
        gateway_ip: "192.168.1.1"  # optional
        gateway_vlan_id: 0  # optional
        ip_version: 0  # optional
        name: "example_name"  # optional
        reserved_ip_ranges:  # optional
          - {}
        static_route_id: "static_route_id_value"  # optional
        subnet: "192.168.1.0/24"  # optional
    state: merged  # optional

- name: Meraki Appliance Static Routes task
  cisco.meraki_rm.meraki_appliance_static_routes:
    network_id: "192.168.1.0/24"  # (str, required) The network ID.
    config:  # (list, optional) List of static route configurations.
      - enabled: true  # (bool, optional) Whether the route is enabled.
        fixed_ip_assignments: {}  # (dict, optional) Fixed DHCP IP assignments on the route.
        gateway_ip: "192.168.1.1"  # (str, optional) Gateway IP address (next hop).
        gateway_vlan_id: 0  # (int, optional) Gateway VLAN ID.
        ip_version: 0  # (int, optional) IP protocol version (4 or 6).
        name: "example_name"  # (str, optional) Name of the route.
        reserved_ip_ranges:  # (list, optional) DHCP reserved IP ranges.
          - {}
        static_route_id: "static_route_id_value"  # (str, optional) Server-assigned ID, resolved automatically by matching on...
        subnet: "192.168.1.0/24"  # (str, optional) Subnet of the route (e.g., 192.168.1.0/24).
    state: merged  # (str, optional) The state of the resource.

Notes

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

Examples

Define Expected Configuration

- name: Define expected configuration
  ansible.builtin.set_fact:
    expected_config:
      name: Test-Config
      subnet: 192.168.128.0/24
      gateway_ip: 10.0.0.1
      gateway_vlan_id: 1
      enabled: true
      ip_version: 1

Create Appliance_static_routes With Merged State

- name: Create appliance_static_routes with merged state
  cisco.meraki_rm.meraki_appliance_static_routes:
    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 appliance static routes — full resource replacement

Define Replacement Configuration

- name: Define replacement configuration
  ansible.builtin.set_fact:
    expected_config:
      name: Test-Config
      subnet: 10.20.0.0/24
      gateway_ip: 10.0.0.1
      gateway_vlan_id: 1
      enabled: false
      ip_version: 1

Replace Appliance_static_routes Configuration

- name: Replace appliance_static_routes configuration
  cisco.meraki_rm.meraki_appliance_static_routes:
    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 appliance static routes — 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
      subnet: 10.20.0.0/24
      gateway_ip: 10.0.0.1
      gateway_vlan_id: 1
      enabled: false
      ip_version: 1

Override All Appliance_static_routes — Desired State Only

- name: Override all appliance_static_routes — desired state only
  cisco.meraki_rm.meraki_appliance_static_routes:
    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 appliance static routes — gather current configuration

Gather Current Appliance_static_routes Configuration

- name: Gather current appliance_static_routes configuration
  cisco.meraki_rm.meraki_appliance_static_routes:
    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 appliance static routes — remove configuration

Define Resource To Delete

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

Delete Appliance_static_routes Configuration

- name: Delete appliance_static_routes configuration
  cisco.meraki_rm.meraki_appliance_static_routes:
    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 appliance static routes — create or update

- name: Define expected configuration
  ansible.builtin.set_fact:
    expected_config:
      name: Test-Config
      subnet: 192.168.128.0/24
      gateway_ip: 10.0.0.1
      gateway_vlan_id: 1
      enabled: true
      ip_version: 1

- name: Create appliance_static_routes with merged state
  cisco.meraki_rm.meraki_appliance_static_routes:
    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 appliance static routes — full resource replacement

- name: Define replacement configuration
  ansible.builtin.set_fact:
    expected_config:
      name: Test-Config
      subnet: 10.20.0.0/24
      gateway_ip: 10.0.0.1
      gateway_vlan_id: 1
      enabled: false
      ip_version: 1

- name: Replace appliance_static_routes configuration
  cisco.meraki_rm.meraki_appliance_static_routes:
    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 appliance static routes — 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
      subnet: 10.20.0.0/24
      gateway_ip: 10.0.0.1
      gateway_vlan_id: 1
      enabled: false
      ip_version: 1

- name: Override all appliance_static_routes — desired state only
  cisco.meraki_rm.meraki_appliance_static_routes:
    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 appliance static routes — gather current configuration

- name: Gather current appliance_static_routes configuration
  cisco.meraki_rm.meraki_appliance_static_routes:
    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 appliance static routes — remove configuration

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

- name: Delete appliance_static_routes configuration
  cisco.meraki_rm.meraki_appliance_static_routes:
    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.