Configure Devices

Location in Dashboard: Not configurable in dashboard, API call only: {{baseUrl}}/organizations/:organizationID/devices

Diagram

Classes

networks (meraki.domains.organizations)

Name	Type	Constraint	Mandatory	Default Value
devices	List	[devices]	No

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
template_name	String	min: 1, max: 127	No
appliance_radio_settings	Class	[appliance_radio_settings]	No
appliance_uplinks_settings	Class	[appliance_uplinks_settings]	No
appliance_vmx_authentication_token	Class	[appliance_vmx_authentication_token]	No
management_interface	Class	[management_interface]	No
switch_ports	List	[switch_ports]	No
switch_routing_interfaces	List	[switch_routing_interfaces]	No
switch_routing_static_routes	List	[switch_routing_static_routes]	No
switch_warm_spare	Class	[switch_warm_spare]	No
wireless_alternate_management_interface_ipv6	Class	[wireless_alternate_management_interface_ipv6]	No
wireless_bluetooth_settings	Class	[wireless_bluetooth_settings]	No
wireless_radio_settings	Class	[wireless_radio_settings]	No

appliance_radio_settings (meraki.domains.organizations.networks.devices)

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

appliance_uplinks_settings (meraki.domains.organizations.networks.devices)

Name	Type	Constraint	Mandatory	Default Value
interfaces	Class	[interfaces]	Yes

appliance_vmx_authentication_token (meraki.domains.organizations.networks.devices)

Name	Type	Constraint	Mandatory	Default Value
serial	String	Regex: ^[A-Z0-9]{4}-[A-Z0-9]{4}-[A-Z0-9]{4}$	Yes

management_interface (meraki.domains.organizations.networks.devices)

Name	Type	Constraint	Mandatory	Default Value
wan1	Class	[wan1]	No
wan2	Class	[wan2]	No

switch_ports (meraki.domains.organizations.networks.devices)

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, 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	Class	[dot3az]	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_ids	String	Regex: \d{1,3}	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

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

switch_routing_static_routes (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
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

switch_warm_spare (meraki.domains.organizations.networks.devices)

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

wireless_alternate_management_interface_ipv6 (meraki.domains.organizations.networks.devices)

Name	Type	Constraint	Mandatory	Default Value
addresses	List	[addresses]	No

wireless_bluetooth_settings (meraki.domains.organizations.networks.devices)

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

wireless_radio_settings (meraki.domains.organizations.networks.devices)

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)

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)

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

interfaces (meraki.domains.organizations.networks.devices.appliance_uplinks_settings)

Name	Type	Constraint	Mandatory	Default Value
wan1	Class	[wan1]	No
wan2	Class	[wan2]	No

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)

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

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

dot3az (meraki.domains.organizations.networks.devices.switch_ports)

Name	Type	Constraint	Mandatory	Default Value
enabled	Boolean	true, false	No

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)

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

dhcp (meraki.domains.organizations.networks.devices.switch_routing_interfaces)

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

addresses (meraki.domains.organizations.networks.devices.wireless_alternate_management_interface_ipv6)

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	Class	[nameservers]	No

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)

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.interfaces)

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.interfaces)

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

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)

Name	Type	Constraint	Mandatory	Default Value
start	IP		Yes
end	IP		Yes
comment	String	min: 1, max: 127	No

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

nameservers (meraki.domains.organizations.networks.devices.wireless_alternate_management_interface_ipv6.addresses)

Name	Type	Constraint	Mandatory	Default Value
addresses	List	String[min: 1, max: 1024]	No

vlan_tagging (meraki.domains.organizations.networks.devices.appliance_uplinks_settings.interfaces.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.interfaces.wan1)

Name	Type	Constraint	Mandatory	Default Value
ipv4	Class	[ipv4]	No
ipv6	Class	[ipv6]	No

pppoe (meraki.domains.organizations.networks.devices.appliance_uplinks_settings.interfaces.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.interfaces.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.interfaces.wan2)

Name	Type	Constraint	Mandatory	Default Value
ipv4	Class	[ipv4]	No
ipv6	Class	[ipv6]	No

pppoe (meraki.domains.organizations.networks.devices.appliance_uplinks_settings.interfaces.wan2)

Name	Type	Constraint	Mandatory	Default Value
enabled	Boolean	true, false	No
authentication	Class	[authentication]	No

ipv4 (meraki.domains.organizations.networks.devices.appliance_uplinks_settings.interfaces.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	Class	[nameservers]	No

ipv6 (meraki.domains.organizations.networks.devices.appliance_uplinks_settings.interfaces.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	Class	[nameservers]	No

authentication (meraki.domains.organizations.networks.devices.appliance_uplinks_settings.interfaces.wan1.pppoe)

Name	Type	Constraint	Mandatory	Default Value
enabled	Boolean	true, false	No
username	String	min: 1, max: 127	No
password	String	min: 6, max: 64	No

ipv4 (meraki.domains.organizations.networks.devices.appliance_uplinks_settings.interfaces.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	Class	[nameservers]	No

ipv6 (meraki.domains.organizations.networks.devices.appliance_uplinks_settings.interfaces.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	Class	[nameservers]	No

authentication (meraki.domains.organizations.networks.devices.appliance_uplinks_settings.interfaces.wan2.pppoe)

Name	Type	Constraint	Mandatory	Default Value
enabled	Boolean	true, false	No
username	String	min: 1, max: 127	No
password	String	min: 6, max: 64	No

nameservers (meraki.domains.organizations.networks.devices.appliance_uplinks_settings.interfaces.wan1.svis.ipv4)

Name	Type	Constraint	Mandatory	Default Value
addresses	List	String[min: 1, max: 1024]	No

nameservers (meraki.domains.organizations.networks.devices.appliance_uplinks_settings.interfaces.wan1.svis.ipv6)

Name	Type	Constraint	Mandatory	Default Value
addresses	List	String[min: 1, max: 1024]	No

nameservers (meraki.domains.organizations.networks.devices.appliance_uplinks_settings.interfaces.wan2.svis.ipv4)

Name	Type	Constraint	Mandatory	Default Value
addresses	List	String[min: 1, max: 1024]	No

nameservers (meraki.domains.organizations.networks.devices.appliance_uplinks_settings.interfaces.wan2.svis.ipv6)

Name	Type	Constraint	Mandatory	Default Value
addresses	List	String[min: 1, max: 1024]	No

Config Sample

meraki:
    domains:
      - name: EMEA
        administrator:
            name: Foo Bar
        organizations:
          - name: Dev
            networks:
              - name: Dev-main-cx-provider
                product_types:
                - appliance
                - camera
                - switch
                - wireless
                devices:
                - name: Core Switch 01
                  serial: AAAA-BBBB-DDDD
                  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: Core Switch 02
                  serial:  AAAA-BBBB-EEEE
                  tags:
                    - test
                  lat: 37.41809510000001
                  lng: -122.098531
                  address: 500 Terry A Francois Blvd
                  notes: Example data.yaml file
                - name: AP 01
                  serial: AAAA-BBBB-FFFF
                  tags:
                    - test
                  lat: 37.41809510000001
                  lng: -122.098531
                  address: 500 Terry A Francois Blvd
                  notes: Example data.yaml file
                - name: DMZ Switch 01
                  serial: AAAA-BBBB-GGGG
                  tags:
                    - test
                  lat: 37.41809510000001
                  lng: -122.098531
                  address: 500 Terry A Francois Blvd
                  notes: Example data.yaml file
                - name: Appliance 01
                  serial: AAAA-BBBB-HHHH
                  tags:
                    - test
                  lat: 37.41809510000001
                  lng: -122.098531
                  address: 500 Terry A Francois Blvd
                  notes: Example data.yaml file
                - name: L3 Switch 01
                  serial: AAAA-BBBB-IIII
                  tags:
                    - test
                  lat: 37.41809510000001
                  lng: -122.098531
                  address: 500 Terry A Francois Blvd
                  notes: Example data.yaml file