Configure Devices
Dashboard Location: Organization > Configure > General > Claim devices
Device Configuration
Section titled “Device Configuration”Organization device configuration in Meraki allows you to manage and organize your infrastructure devices across organizations. This includes claiming devices, setting device-specific properties, and organizing devices through tagging and location assignment. Device configuration is essential for establishing proper network topology and enabling centralized management of your Meraki infrastructure.
Diagram
Section titled “Diagram”Classes
Section titled “Classes”networks (meraki.domains.organizations)
Section titled “networks (meraki.domains.organizations)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| devices | List | [devices] | No |
devices (meraki.domains.organizations.networks)
Section titled “devices (meraki.domains.organizations.networks)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| serial | String | Regex: ^[A-Z0-9]{4}-[A-Z0-9]{4}-[A-Z0-9]{4}$ | No | |
| name | String | min: 1, max: 127 | No | |
| tags | List | String[min: 1, max: 255] | No | |
| lat | Number | min: -90, max: 90 | No | |
| lng | Number | min: -180, max: 180 | No | |
| address | String | min: 1, max: 1024 | No | |
| notes | String | min: 1, max: 1024 | No | |
| move_map_marker | Boolean | true, false | No | |
| floor_plan_name | String | min: 1, max: 127 | No | |
| switch_profile_name | String | min: 1, max: 127 | No | |
| sensor_commands | Choice | enableDownstreamPower, disableDownstreamPower, cycleDownstreamPower, refreshData | No | |
| sensor_relationships | List | Any[String[matches: ^[A-Z0-9]{4}-[A-Z0-9]{4}-[A-Z0-9]{4}$] or String[min: 1, max: 127]] | No | |
| template_name | String | min: 1, max: 127 | No | |
| appliance | Class | [appliance] | No | |
| camera | Class | [camera] | No | |
| cellular_sims | Class | [cellular_sims] | No | |
| cellular_gateway | Class | [cellular_gateway] | No | |
| management_interface | Class | [management_interface] | No | |
| switch | Class | [switch] | No | |
| switch_routing_interfaces | List | [switch_routing_interfaces] | No | |
| wireless | Class | [wireless] | No |
appliance (meraki.domains.organizations.networks.devices)
Section titled “appliance (meraki.domains.organizations.networks.devices)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | min: 1, max: 127 | No | |
| vmx_authentication_token | Any | String[matches: ^[A-Z0-9]{4}-[A-Z0-9]{4}-[A-Z0-9]{4}$] or String[min: 1, max: 127] | No | |
| radio_settings | Class | [radio_settings] | No | |
| uplinks_settings | Class | [uplinks_settings] | No |
camera (meraki.domains.organizations.networks.devices)
Section titled “camera (meraki.domains.organizations.networks.devices)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | min: 1, max: 127 | No | |
| video_settings_external_rtsp | Boolean | true, false | No | |
| custom_analytics | Class | [custom_analytics] | No | |
| generate_snapshot | Class | [generate_snapshot] | No | |
| quality_and_retention | Class | [quality_and_retention] | No | |
| sense | Class | [sense] | No | |
| wireless_profiles | Class | [wireless_profiles] | No |
cellular_sims (meraki.domains.organizations.networks.devices)
Section titled “cellular_sims (meraki.domains.organizations.networks.devices)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| sims | List | [sims] | No | |
| sim_ordering | List | Choice[sim1, sim2, sim3] | No | |
| sim_failover | Class | [sim_failover] | No |
cellular_gateway (meraki.domains.organizations.networks.devices)
Section titled “cellular_gateway (meraki.domains.organizations.networks.devices)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | min: 1, max: 127 | No | |
| lan | Class | [lan] | No | |
| port_forwarding_rules | List | [port_forwarding_rules] | No |
management_interface (meraki.domains.organizations.networks.devices)
Section titled “management_interface (meraki.domains.organizations.networks.devices)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| wan1 | Class | [wan1] | No | |
| wan2 | Class | [wan2] | No |
switch (meraki.domains.organizations.networks.devices)
Section titled “switch (meraki.domains.organizations.networks.devices)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | min: 1, max: 127 | No | |
| ports | List | [ports] | No | |
| routing_interfaces_dhcp | Class | [routing_interfaces_dhcp] | No | |
| routing_static_routes | List | [routing_static_routes] | No | |
| warm_spare | Class | [warm_spare] | No |
switch_routing_interfaces (meraki.domains.organizations.networks.devices)
Section titled “switch_routing_interfaces (meraki.domains.organizations.networks.devices)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | min: 1, max: 127 | No | |
| subnet | String | Regex: ^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\/([1-9]|[12][0-9]|3[0-2])$ | No | |
| interface_ip | IP | No | ||
| multicast_routing | Choice | IGMP snooping querier, disabled, enabled | No | |
| vlan_id | Any | Integer[min: 1, max: 4094] or String[matches: `(?:[1-9] | [1-9][0-9] | [1-9][0-9]2 |
| default_gateway | IP | No | ||
| ospf_settings | Class | [ospf_settings] | No | |
| ipv6 | Class | [ipv6] | No | |
| dhcp | Class | [dhcp] | No |
wireless (meraki.domains.organizations.networks.devices)
Section titled “wireless (meraki.domains.organizations.networks.devices)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | min: 1, max: 127 | No | |
| alternate_management_interface_ipv6 | Class | [alternate_management_interface_ipv6] | No | |
| bluetooth_settings | Class | [bluetooth_settings] | No | |
| electronic_shelf_label | Class | [electronic_shelf_label] | No | |
| radio_settings | Class | [radio_settings] | No |
radio_settings (meraki.domains.organizations.networks.devices.appliance)
Section titled “radio_settings (meraki.domains.organizations.networks.devices.appliance)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| two_four_ghz_settings | Class | [two_four_ghz_settings] | No | |
| five_ghz_settings | Class | [five_ghz_settings] | No | |
| rf_profile_name | String | min: 1, max: 127 | No |
uplinks_settings (meraki.domains.organizations.networks.devices.appliance)
Section titled “uplinks_settings (meraki.domains.organizations.networks.devices.appliance)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| wan1 | Class | [wan1] | No | |
| wan2 | Class | [wan2] | No |
custom_analytics (meraki.domains.organizations.networks.devices.camera)
Section titled “custom_analytics (meraki.domains.organizations.networks.devices.camera)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| enabled | Boolean | true, false | No | |
| parameters | List | [parameters] | No | |
| artifact_name | String | min: 1, max: 127 | No |
generate_snapshot (meraki.domains.organizations.networks.devices.camera)
Section titled “generate_snapshot (meraki.domains.organizations.networks.devices.camera)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| timestamp | String | Regex: ^(\d{4}-[01]\d-[0-3]\d[T\s][0-2]\d:[0-5]\d:[0-5]\d(\.\d+)?([+-][0-2]\d:[0-5]\d|Z)?)$ | No | |
| fullframe | Boolean | true, false | No |
quality_and_retention (meraki.domains.organizations.networks.devices.camera)
Section titled “quality_and_retention (meraki.domains.organizations.networks.devices.camera)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| quality | Choice | Enhanced, High, Standard, Ultra | No | |
| resolution | Choice | 1080x1080, 1280x720, 1920x1080, 2112x2112, 2688x1512, 2880x2880, 3840x2160 | No | |
| motion_detector_version | Choice | 1, 2 | No | |
| motion_based_retention | Boolean | true, false | No | |
| audio_recording | Boolean | true, false | No | |
| restricted_bandwidth_mode | Boolean | true, false | No | |
| profile_name | String | min: 1, max: 127 | No |
sense (meraki.domains.organizations.networks.devices.camera)
Section titled “sense (meraki.domains.organizations.networks.devices.camera)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| audio_detection | Boolean | true, false | No | |
| sense | Boolean | true, false | No | |
| mqtt_broker_name | String | min: 1, max: 127 | No | |
| detection_model_name | String | min: 1, max: 127 | No |
wireless_profiles (meraki.domains.organizations.networks.devices.camera)
Section titled “wireless_profiles (meraki.domains.organizations.networks.devices.camera)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| primary | String | min: 1, max: 127 | No | |
| secondary | String | min: 1, max: 127 | No | |
| backup | String | min: 1, max: 127 | No |
sims (meraki.domains.organizations.networks.devices.cellular_sims)
Section titled “sims (meraki.domains.organizations.networks.devices.cellular_sims)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| slot | Choice | sim1, sim2, sim3 | No | |
| is_primary | Boolean | true, false | No | |
| apns | List | [apns] | No | |
| sim_order | Integer | min: 1, max: 3 | No |
sim_failover (meraki.domains.organizations.networks.devices.cellular_sims)
Section titled “sim_failover (meraki.domains.organizations.networks.devices.cellular_sims)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| enabled | Boolean | true, false | No | |
| timeout | Integer | min: 1, max: 600 | No |
lan (meraki.domains.organizations.networks.devices.cellular_gateway)
Section titled “lan (meraki.domains.organizations.networks.devices.cellular_gateway)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| reserved_ip_ranges | List | [reserved_ip_ranges] | No | |
| fixed_ip_assignments | List | [fixed_ip_assignments] | No |
port_forwarding_rules (meraki.domains.organizations.networks.devices.cellular_gateway)
Section titled “port_forwarding_rules (meraki.domains.organizations.networks.devices.cellular_gateway)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | min: 1, max: 127 | No | |
| lan_ip | IP | Yes | ||
| public_port | Any | Integer[min: 1, max: 65535] or String[matches: `(?:[1-9][0-9]3 | [1-5][0-9]4 | 6[0-4][0-9]3 |
| local_port | Any | Integer[min: 1, max: 65535] or String[matches: `(?:[1-9][0-9]3 | [1-5][0-9]4 | 6[0-4][0-9]3 |
| allowed_ips | List | Any[IP or String[matches: [Aa]ny]] | No | |
| protocol | Choice | TCP, UDP, tcp, udp | Yes | |
| access | Choice | Any, ANY, any, Restricted, restricted, RESTRICTED | Yes |
wan1 (meraki.domains.organizations.networks.devices.management_interface)
Section titled “wan1 (meraki.domains.organizations.networks.devices.management_interface)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| using_static_ip | Boolean | true, false | No | |
| static_ip | IP | No | ||
| static_gateway_ip | IP | No | ||
| static_subnet_mask | String | Regex: ^(255|254|252|248|240|224|192|128|0+)(\.0|\.128|\.192|\.224|\.240|\.248|\.252|\.254|\.255){0,3}$ | No | |
| static_dns | List | String[min: 1, max: 1024] | No | |
| vlan | Any | Integer[min: 1, max: 4094] or String[matches: `(?:[1-9] | [1-9][0-9] | [1-9][0-9]2 |
| wan | Choice | disabled, enabled, not configured | No |
wan2 (meraki.domains.organizations.networks.devices.management_interface)
Section titled “wan2 (meraki.domains.organizations.networks.devices.management_interface)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| using_static_ip | Boolean | true, false | No | |
| static_ip | IP | No | ||
| static_gateway_ip | IP | No | ||
| static_subnet_mask | String | Regex: ^(255|254|252|248|240|224|192|128|0+)(\.0|\.128|\.192|\.224|\.240|\.248|\.252|\.254|\.255){0,3}$ | No | |
| static_dns | List | String[min: 1, max: 1024] | No | |
| vlan | Any | Integer[min: 1, max: 4094] or String[matches: `(?:[1-9] | [1-9][0-9] | [1-9][0-9]2 |
| wan | Choice | disabled, enabled, not configured | No |
ports (meraki.domains.organizations.networks.devices.switch)
Section titled “ports (meraki.domains.organizations.networks.devices.switch)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | min: 1, max: 127 | No | |
| tags | List | String[min: 1, max: 255] | No | |
| enabled | Boolean | true, false | No | |
| type | Choice | access, routed, stack, trunk | No | |
| vlan | Any | Integer[min: 1, max: 4094] or String[matches: `(?:[1-9] | [1-9][0-9] | [1-9][0-9]2 |
| voice_vlan | Any | Integer[min: 1, max: 4094] or String[matches: `(?:[1-9] | [1-9][0-9] | [1-9][0-9]2 |
| allowed_vlans | Any | Integer[min: 1, max: 4094] or String[matches: `(?:[1-9] | [1-9][0-9] | [1-9][0-9]2 |
| stp_guard | Choice | bpdu guard, disabled, loop guard, root guard | No | |
| link_negotiation | String | min: 1, max: 127 | No | |
| udld | Choice | Alert only, Enforce | No | |
| access_policy_type | Choice | Custom access policy, MAC allow list, Open, Sticky MAC allow list | No | |
| mac_allow_list | List | MAC | No | |
| sticky_mac_allow_list | List | MAC | No | |
| sticky_mac_allow_list_limit | Integer | min: 1, max: 10 | No | |
| peer_sgt_capable | Boolean | true, false | No | |
| dai_trusted | Boolean | true, false | No | |
| profile | Class | [profile] | No | |
| dot3az | Boolean | true, false | No | |
| poe | Boolean | true, false | No | |
| isolation | Boolean | true, false | No | |
| rstp | Boolean | true, false | No | |
| storm_control | Boolean | true, false | No | |
| flexible_stacking | Boolean | true, false | No | |
| port_id_ranges | List | [port_id_ranges] | No | |
| port_schedule_name | String | min: 1, max: 127 | No | |
| access_policy_name | String | min: 1, max: 127 | No | |
| adaptive_policy_group_name | String | min: 1, max: 127 | No |
routing_interfaces_dhcp (meraki.domains.organizations.networks.devices.switch)
Section titled “routing_interfaces_dhcp (meraki.domains.organizations.networks.devices.switch)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| dhcp_mode | Choice | dhcpDisabled, dhcpRelay, dhcpServer | No | |
| dhcp_relay_server_ips | List | IP | No | |
| dhcp_lease_time | Choice | 1 day, 1 hour, 1 week, 12 hours, 30 minutes, 4 hours | No | |
| dns_nameservers_option | Choice | custom, googlePublicDns, openDns | No | |
| dns_custom_nameservers | List | IP | No | |
| boot_next_server | IP | No | ||
| boot_file_name | String | min: 1, max: 127 | No | |
| dhcp_options | List | [dhcp_options] | No | |
| reserved_ip_ranges | List | [reserved_ip_ranges] | No | |
| fixed_ip_assignments | List | [fixed_ip_assignments] | No | |
| boot_options | Boolean | true, false | No |
routing_static_routes (meraki.domains.organizations.networks.devices.switch)
Section titled “routing_static_routes (meraki.domains.organizations.networks.devices.switch)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | min: 1, max: 127 | No | |
| subnet | String | Regex: ^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\/([1-9]|[12][0-9]|3[0-2])$ | No | |
| next_hop_ip | IP | No | ||
| advertise_via_ospf | Boolean | true, false | No | |
| prefer_over_ospf_routes | Boolean | true, false | No | |
| management_next_hop | IP | No |
warm_spare (meraki.domains.organizations.networks.devices.switch)
Section titled “warm_spare (meraki.domains.organizations.networks.devices.switch)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| enabled | Boolean | true, false | Yes | |
| spare_device | Any | String[matches: ^[A-Z0-9]{4}-[A-Z0-9]{4}-[A-Z0-9]{4}$] or String[min: 1, max: 127] | No |
ospf_settings (meraki.domains.organizations.networks.devices.switch_routing_interfaces)
Section titled “ospf_settings (meraki.domains.organizations.networks.devices.switch_routing_interfaces)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| area | Any | String[min: 1, max: 13] or IP or Integer[min: 1, max: 4294967295] | No | |
| cost | Integer | min: 1, max: 65535 | No | |
| is_passive | Boolean | true, false | No |
ipv6 (meraki.domains.organizations.networks.devices.switch_routing_interfaces)
Section titled “ipv6 (meraki.domains.organizations.networks.devices.switch_routing_interfaces)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| assignment_mode | Choice | eui-64, static | No | |
| prefix | String | min: 1, max: 1024 | No | |
| address | String | min: 1, max: 1024 | No | |
| gateway | IP | No |
alternate_management_interface_ipv6 (meraki.domains.organizations.networks.devices.wireless)
Section titled “alternate_management_interface_ipv6 (meraki.domains.organizations.networks.devices.wireless)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| protocol | Choice | ipv4, ipv6 | No | |
| assignment_mode | Choice | dynamic, static | No | |
| address | String | min: 1, max: 1024 | No | |
| gateway | IP | No | ||
| prefix | String | min: 1, max: 1024 | No | |
| nameservers | List | IP | No |
bluetooth_settings (meraki.domains.organizations.networks.devices.wireless)
Section titled “bluetooth_settings (meraki.domains.organizations.networks.devices.wireless)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| uuid | String | Regex: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{3,4}-[0-9a-fA-F]{12}$ | No | |
| major | Integer | min: 0, max: 31 | No | |
| minor | Integer | min: 0, max: 125 | No |
electronic_shelf_label (meraki.domains.organizations.networks.devices.wireless)
Section titled “electronic_shelf_label (meraki.domains.organizations.networks.devices.wireless)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| channel | String | No | ||
| enabled | Boolean | true, false | No |
radio_settings (meraki.domains.organizations.networks.devices.wireless)
Section titled “radio_settings (meraki.domains.organizations.networks.devices.wireless)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| two_four_ghz_settings | Class | [two_four_ghz_settings] | No | |
| five_ghz_settings | Class | [five_ghz_settings] | No | |
| rf_profile_name | String | min: 1, max: 127 | No |
two_four_ghz_settings (meraki.domains.organizations.networks.devices.appliance.radio_settings)
Section titled “two_four_ghz_settings (meraki.domains.organizations.networks.devices.appliance.radio_settings)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| channel | Choice | 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13 | No | |
| target_power | Integer | min: 2, max: 30 | No |
five_ghz_settings (meraki.domains.organizations.networks.devices.appliance.radio_settings)
Section titled “five_ghz_settings (meraki.domains.organizations.networks.devices.appliance.radio_settings)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| channel | Choice | 36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140, 144, 149, 153, 157, 161, 165 | No | |
| channel_width | Choice | 0, 20, 40, 80, 160 | No | |
| target_power | Integer | min: 2, max: 30 | No |
wan1 (meraki.domains.organizations.networks.devices.appliance.uplinks_settings)
Section titled “wan1 (meraki.domains.organizations.networks.devices.appliance.uplinks_settings)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| enabled | Boolean | true, false | No | |
| vlan_tagging | Class | [vlan_tagging] | No | |
| svis | Class | [svis] | No | |
| pppoe | Class | [pppoe] | No |
wan2 (meraki.domains.organizations.networks.devices.appliance.uplinks_settings)
Section titled “wan2 (meraki.domains.organizations.networks.devices.appliance.uplinks_settings)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| enabled | Boolean | true, false | No | |
| vlan_tagging | Class | [vlan_tagging] | No | |
| svis | Class | [svis] | No | |
| pppoe | Class | [pppoe] | No |
parameters (meraki.domains.organizations.networks.devices.camera.custom_analytics)
Section titled “parameters (meraki.domains.organizations.networks.devices.camera.custom_analytics)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | min: 1, max: 127 | Yes | |
| value | String | min: 1, max: 127 | Yes |
apns (meraki.domains.organizations.networks.devices.cellular_sims.sims)
Section titled “apns (meraki.domains.organizations.networks.devices.cellular_sims.sims)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | min: 1, max: 127 | Yes | |
| allowed_ip_types | List | Choice[ipv4, ipv6, IPV4, IPV6] | Yes | |
| authentication | Class | [authentication] | No |
reserved_ip_ranges (meraki.domains.organizations.networks.devices.cellular_gateway.lan)
Section titled “reserved_ip_ranges (meraki.domains.organizations.networks.devices.cellular_gateway.lan)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| start | IP | Yes | ||
| end | IP | Yes | ||
| comment | String | min: 1, max: 127 | Yes |
fixed_ip_assignments (meraki.domains.organizations.networks.devices.cellular_gateway.lan)
Section titled “fixed_ip_assignments (meraki.domains.organizations.networks.devices.cellular_gateway.lan)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | min: 1, max: 127 | No | |
| ip | IP | Yes | ||
| mac | MAC | Yes |
profile (meraki.domains.organizations.networks.devices.switch.ports)
Section titled “profile (meraki.domains.organizations.networks.devices.switch.ports)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| enabled | Boolean | true, false | No | |
| iname | String | min: 1, max: 127 | No | |
| name | String | min: 1, max: 127 | No |
port_id_ranges (meraki.domains.organizations.networks.devices.switch.ports)
Section titled “port_id_ranges (meraki.domains.organizations.networks.devices.switch.ports)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| from | Any | Integer[min: 1, max: 24] or String[matches: ^\d{1,3}$] | Yes | |
| to | Any | Integer[min: 1, max: 24] or String[matches: ^\d{1,3}$] | Yes |
dhcp_options (meraki.domains.organizations.networks.devices.switch.routing_interfaces_dhcp)
Section titled “dhcp_options (meraki.domains.organizations.networks.devices.switch.routing_interfaces_dhcp)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| code | String | Regex: ^([2-9]|1[0-9][0-9]?|2[0-9]|2[0-5][0-4]|[3-9][0-9])$ | Yes | |
| type | Choice | hex, integer, ip, text | Yes | |
| value | String | min: 1, max: 127 | Yes |
reserved_ip_ranges (meraki.domains.organizations.networks.devices.switch.routing_interfaces_dhcp)
Section titled “reserved_ip_ranges (meraki.domains.organizations.networks.devices.switch.routing_interfaces_dhcp)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| start | IP | Yes | ||
| end | IP | Yes | ||
| comment | String | min: 1, max: 127 | Yes |
fixed_ip_assignments (meraki.domains.organizations.networks.devices.switch.routing_interfaces_dhcp)
Section titled “fixed_ip_assignments (meraki.domains.organizations.networks.devices.switch.routing_interfaces_dhcp)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | min: 1, max: 127 | Yes | |
| mac | MAC | Yes | ||
| ip | IP | Yes |
two_four_ghz_settings (meraki.domains.organizations.networks.devices.wireless.radio_settings)
Section titled “two_four_ghz_settings (meraki.domains.organizations.networks.devices.wireless.radio_settings)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| channel | Choice | 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13 | No | |
| target_power | Integer | min: 2, max: 30 | No |
five_ghz_settings (meraki.domains.organizations.networks.devices.wireless.radio_settings)
Section titled “five_ghz_settings (meraki.domains.organizations.networks.devices.wireless.radio_settings)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| channel | Choice | 36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140, 144, 149, 153, 157, 161, 165 | No | |
| channel_width | Choice | 0, 20, 40, 80, 160 | No | |
| target_power | Integer | min: 2, max: 30 | No |
vlan_tagging (meraki.domains.organizations.networks.devices.appliance.uplinks_settings.wan1)
Section titled “vlan_tagging (meraki.domains.organizations.networks.devices.appliance.uplinks_settings.wan1)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| enabled | Boolean | true, false | No | |
| vlan_id | Any | Integer[min: 1, max: 4094] or String[matches: `(?:[1-9] | [1-9][0-9] | [1-9][0-9]2 |
svis (meraki.domains.organizations.networks.devices.appliance.uplinks_settings.wan1)
Section titled “svis (meraki.domains.organizations.networks.devices.appliance.uplinks_settings.wan1)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| ipv4 | Class | [ipv4] | No | |
| ipv6 | Class | [ipv6] | No |
pppoe (meraki.domains.organizations.networks.devices.appliance.uplinks_settings.wan1)
Section titled “pppoe (meraki.domains.organizations.networks.devices.appliance.uplinks_settings.wan1)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| enabled | Boolean | true, false | No | |
| authentication | Class | [authentication] | No |
vlan_tagging (meraki.domains.organizations.networks.devices.appliance.uplinks_settings.wan2)
Section titled “vlan_tagging (meraki.domains.organizations.networks.devices.appliance.uplinks_settings.wan2)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| enabled | Boolean | true, false | No | |
| vlan_id | Any | Integer[min: 1, max: 4094] or String[matches: `(?:[1-9] | [1-9][0-9] | [1-9][0-9]2 |
svis (meraki.domains.organizations.networks.devices.appliance.uplinks_settings.wan2)
Section titled “svis (meraki.domains.organizations.networks.devices.appliance.uplinks_settings.wan2)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| ipv4 | Class | [ipv4] | No | |
| ipv6 | Class | [ipv6] | No |
pppoe (meraki.domains.organizations.networks.devices.appliance.uplinks_settings.wan2)
Section titled “pppoe (meraki.domains.organizations.networks.devices.appliance.uplinks_settings.wan2)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| enabled | Boolean | true, false | No | |
| authentication | Class | [authentication] | No |
authentication (meraki.domains.organizations.networks.devices.cellular_sims.sims.apns)
Section titled “authentication (meraki.domains.organizations.networks.devices.cellular_sims.sims.apns)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| type | Choice | chap, none, pap | No | |
| username | String | min: 1, max: 127 | No | |
| password | String | min: 5, max: 64 | No |
ipv4 (meraki.domains.organizations.networks.devices.appliance.uplinks_settings.wan1.svis)
Section titled “ipv4 (meraki.domains.organizations.networks.devices.appliance.uplinks_settings.wan1.svis)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| assignment_mode | Choice | dynamic, static | No | |
| address | String | min: 1, max: 1024 | No | |
| gateway | IP | No | ||
| nameservers | List | IP | No |
ipv6 (meraki.domains.organizations.networks.devices.appliance.uplinks_settings.wan1.svis)
Section titled “ipv6 (meraki.domains.organizations.networks.devices.appliance.uplinks_settings.wan1.svis)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| assignment_mode | Choice | dynamic, static | No | |
| address | String | min: 1, max: 1024 | No | |
| gateway | IP | No | ||
| nameservers | List | IP | No |
authentication (meraki.domains.organizations.networks.devices.appliance.uplinks_settings.wan1.pppoe)
Section titled “authentication (meraki.domains.organizations.networks.devices.appliance.uplinks_settings.wan1.pppoe)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| enabled | Boolean | true, false | No | |
| username | String | min: 1, max: 127 | No | |
| password | String | min: 5, max: 64 | No |
ipv4 (meraki.domains.organizations.networks.devices.appliance.uplinks_settings.wan2.svis)
Section titled “ipv4 (meraki.domains.organizations.networks.devices.appliance.uplinks_settings.wan2.svis)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| assignment_mode | Choice | dynamic, static | No | |
| address | String | min: 1, max: 1024 | No | |
| gateway | IP | No | ||
| nameservers | List | IP | No |
ipv6 (meraki.domains.organizations.networks.devices.appliance.uplinks_settings.wan2.svis)
Section titled “ipv6 (meraki.domains.organizations.networks.devices.appliance.uplinks_settings.wan2.svis)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| assignment_mode | Choice | dynamic, static | No | |
| address | String | min: 1, max: 1024 | No | |
| gateway | IP | No | ||
| nameservers | List | IP | No |
authentication (meraki.domains.organizations.networks.devices.appliance.uplinks_settings.wan2.pppoe)
Section titled “authentication (meraki.domains.organizations.networks.devices.appliance.uplinks_settings.wan2.pppoe)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| enabled | Boolean | true, false | No | |
| username | String | min: 1, max: 127 | No | |
| password | String | min: 5, max: 64 | No |
Examples
Section titled “Examples”Example-1: The example below demonstrates basic device configuration for a branch office with essential device properties including serial numbers, location data, and organizational tags.
This configuration defines a set of network devices, including core and access switches, DMZ switches, wireless access points, security appliances, a cellular gateway, a camera, and a sensor. Each device specifies its name, serial number (from environment variables), location (latitude/longitude), physical address, and documentation notes. core_switch_01 is additionally linked to the switch profile “My Switch Profile” and associated with “Floor 1”. All devices are tagged consistently (where applicable) with test for easy grouping and identification.
meraki: domains: - name: !env domain administrator: name: !env org_admin organizations: - name: !env org networks: - name: !env network_name product_types: - appliance - switch - wireless - camera - sensor - cellularGateway devices: - name: !env core_switch_01 serial: !env core_switch_01_serial tags: - test lat: 37.41809510000001 lng: -122.098531 address: 500 Terry A Francois Blvd notes: Example data.yaml file switch_profile_name: "My Switch Profile" floor_plan_name: "Floor 1" - name: !env core_switch_02 serial: !env core_switch_02_serial tags: - test lat: 37.41809510000001 lng: -122.098531 address: 500 Terry A Francois Blvd notes: Example data.yaml file - name: !env access_switch_01 serial: !env access_switch_01_serial tags: - test lat: 37.41809510000001 lng: -122.098531 address: 500 Terry A Francois Blvd notes: Example data.yaml file - name: !env access_switch_02 serial: !env access_switch_02_serial tags: - test lat: 37.41809510000001 lng: -122.098531 address: 500 Terry A Francois Blvd notes: Example data.yaml file - name: !env ap_01 serial: !env ap_01_serial tags: - test lat: 37.41809510000001 lng: -122.098531 address: 500 Terry A Francois Blvd notes: Example data.yaml file - name: !env ap_02 serial: !env ap_02_serial tags: - test lat: 37.41809510000001 lng: -122.098531 address: 500 Terry A Francois Blvd notes: Example data.yaml file - name: !env dmz_switch_01 serial: !env dmz_switch_01_serial tags: - test lat: 37.41809510000001 lng: -122.098531 address: 500 Terry A Francois Blvd notes: Example data.yaml file - name: !env dmz_switch_02 serial: !env dmz_switch_02_serial tags: - test lat: 37.41809510000001 lng: -122.098531 address: 500 Terry A Francois Blvd notes: Example data.yaml file - name: !env appliance_01 serial: !env appliance_01_serial tags: - test lat: 37.41809510000001 lng: -122.098531 address: 500 Terry A Francois Blvd notes: Example data.yaml file - name: !env appliance_02 serial: !env appliance_02_serial tags: - test lat: 37.41809510000001 lng: -122.098531 address: 500 Terry A Francois Blvd notes: Example data.yaml file - name: !env cellular_gateway_01 serial: !env cellular_gateway_01_serial lat: 37.41809510000001 lng: -122.098531 address: 500 Terry A Francois Blvd notes: Example data.yaml file - name: !env camera_01 serial: !env camera_01_serial tags: - test lat: 37.41809510000001 lng: -122.098531 address: 500 Terry A Francois Blvd notes: Example data.yaml file - name: !env sensor_01 serial: !env sensor_01_serial tags: - test lat: 37.41809510000001 lng: -122.098531 address: 500 Terry A Francois Blvd notes: Example data.yaml file