Skip to content

Configure Devices

Dashboard Location: Organization > Configure > General > Claim devices

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

Diagram

Classes

networks (meraki.domains.organizations)

NameTypeConstraintMandatoryDefault Value
devicesList[devices]No

devices (meraki.domains.organizations.networks)

NameTypeConstraintMandatoryDefault Value
serialStringRegex: ^[A-Z0-9]{4}-[A-Z0-9]{4}-[A-Z0-9]{4}$No
nameStringmin: 1, max: 127No
tagsListString[min: 1, max: 255]No
latNumbermin: -90, max: 90No
lngNumbermin: -180, max: 180No
addressStringmin: 1, max: 1024No
notesStringmin: 1, max: 1024No
move_map_markerBooleantrue, falseNo
floor_plan_nameStringmin: 1, max: 127No
switch_profile_nameStringmin: 1, max: 127No
sensor_commandsChoiceenableDownstreamPower, disableDownstreamPower, cycleDownstreamPower, refreshDataNo
sensor_relationshipsListAny[String[matches: ^[A-Z0-9]{4}-[A-Z0-9]{4}-[A-Z0-9]{4}$] or String[min: 1, max: 127]]No
template_nameStringmin: 1, max: 127No
applianceClass[appliance]No
cameraClass[camera]No
cellular_simsClass[cellular_sims]No
cellular_gatewayClass[cellular_gateway]No
management_interfaceClass[management_interface]No
switchClass[switch]No
switch_routing_interfacesList[switch_routing_interfaces]No
wirelessClass[wireless]No

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

NameTypeConstraintMandatoryDefault Value
nameStringmin: 1, max: 127No
vmx_authentication_tokenAnyString[matches: ^[A-Z0-9]{4}-[A-Z0-9]{4}-[A-Z0-9]{4}$] or String[min: 1, max: 127]No
radio_settingsClass[radio_settings]No
uplinks_settingsClass[uplinks_settings]No

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

NameTypeConstraintMandatoryDefault Value
nameStringmin: 1, max: 127No
video_settings_external_rtspBooleantrue, falseNo
custom_analyticsClass[custom_analytics]No
generate_snapshotClass[generate_snapshot]No
quality_and_retentionClass[quality_and_retention]No
senseClass[sense]No
wireless_profilesClass[wireless_profiles]No

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

NameTypeConstraintMandatoryDefault Value
simsList[sims]No
sim_orderingListChoice[sim1, sim2, sim3]No
sim_failoverClass[sim_failover]No

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

NameTypeConstraintMandatoryDefault Value
nameStringmin: 1, max: 127No
lanClass[lan]No
port_forwarding_rulesList[port_forwarding_rules]No

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

NameTypeConstraintMandatoryDefault Value
wan1Class[wan1]No
wan2Class[wan2]No

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

NameTypeConstraintMandatoryDefault Value
nameStringmin: 1, max: 127No
portsList[ports]No
routing_interfaces_dhcpClass[routing_interfaces_dhcp]No
routing_static_routesList[routing_static_routes]No
warm_spareClass[warm_spare]No

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

NameTypeConstraintMandatoryDefault Value
nameStringmin: 1, max: 127No
subnetStringRegex: ^((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_ipIPNo
multicast_routingChoiceIGMP snooping querier, disabled, enabledNo
vlan_idAnyInteger[min: 1, max: 4094] or String[matches: `(?:[1-9][1-9][0-9][1-9][0-9]2
default_gatewayIPNo
ospf_settingsClass[ospf_settings]No
ipv6Class[ipv6]No
dhcpClass[dhcp]No

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

NameTypeConstraintMandatoryDefault Value
nameStringmin: 1, max: 127No
alternate_management_interface_ipv6Class[alternate_management_interface_ipv6]No
bluetooth_settingsClass[bluetooth_settings]No
electronic_shelf_labelClass[electronic_shelf_label]No
radio_settingsClass[radio_settings]No

radio_settings (meraki.domains.organizations.networks.devices.appliance)

NameTypeConstraintMandatoryDefault Value
two_four_ghz_settingsClass[two_four_ghz_settings]No
five_ghz_settingsClass[five_ghz_settings]No
rf_profile_nameStringmin: 1, max: 127No

NameTypeConstraintMandatoryDefault Value
wan1Class[wan1]No
wan2Class[wan2]No

custom_analytics (meraki.domains.organizations.networks.devices.camera)

NameTypeConstraintMandatoryDefault Value
enabledBooleantrue, falseNo
parametersList[parameters]No
artifact_nameStringmin: 1, max: 127No

generate_snapshot (meraki.domains.organizations.networks.devices.camera)

NameTypeConstraintMandatoryDefault Value
timestampStringRegex: ^(\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
fullframeBooleantrue, falseNo

quality_and_retention (meraki.domains.organizations.networks.devices.camera)

NameTypeConstraintMandatoryDefault Value
qualityChoiceEnhanced, High, Standard, UltraNo
resolutionChoice1080x1080, 1280x720, 1920x1080, 2112x2112, 2688x1512, 2880x2880, 3840x2160No
motion_detector_versionChoice1, 2No
motion_based_retentionBooleantrue, falseNo
audio_recordingBooleantrue, falseNo
restricted_bandwidth_modeBooleantrue, falseNo
profile_nameStringmin: 1, max: 127No

sense (meraki.domains.organizations.networks.devices.camera)

NameTypeConstraintMandatoryDefault Value
audio_detectionBooleantrue, falseNo
senseBooleantrue, falseNo
mqtt_broker_nameStringmin: 1, max: 127No
detection_model_nameStringmin: 1, max: 127No

wireless_profiles (meraki.domains.organizations.networks.devices.camera)

NameTypeConstraintMandatoryDefault Value
primaryStringmin: 1, max: 127No
secondaryStringmin: 1, max: 127No
backupStringmin: 1, max: 127No

sims (meraki.domains.organizations.networks.devices.cellular_sims)

NameTypeConstraintMandatoryDefault Value
slotChoicesim1, sim2, sim3No
is_primaryBooleantrue, falseNo
apnsList[apns]No
sim_orderIntegermin: 1, max: 3No

sim_failover (meraki.domains.organizations.networks.devices.cellular_sims)

NameTypeConstraintMandatoryDefault Value
enabledBooleantrue, falseNo
timeoutIntegermin: 1, max: 600No

lan (meraki.domains.organizations.networks.devices.cellular_gateway)

NameTypeConstraintMandatoryDefault Value
reserved_ip_rangesList[reserved_ip_ranges]No
fixed_ip_assignmentsList[fixed_ip_assignments]No

port_forwarding_rules (meraki.domains.organizations.networks.devices.cellular_gateway)

NameTypeConstraintMandatoryDefault Value
nameStringmin: 1, max: 127No
lan_ipIPYes
public_portAnyInteger[min: 1, max: 65535] or String[matches: `(?:[1-9][0-9]3[1-5][0-9]46[0-4][0-9]3
local_portAnyInteger[min: 1, max: 65535] or String[matches: `(?:[1-9][0-9]3[1-5][0-9]46[0-4][0-9]3
allowed_ipsListAny[IP or String[matches: [Aa]ny]]No
protocolChoiceTCP, UDP, tcp, udpYes
accessChoiceAny, ANY, any, Restricted, restricted, RESTRICTEDYes

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

NameTypeConstraintMandatoryDefault Value
using_static_ipBooleantrue, falseNo
static_ipIPNo
static_gateway_ipIPNo
static_subnet_maskStringRegex: ^(255|254|252|248|240|224|192|128|0+)(\.0|\.128|\.192|\.224|\.240|\.248|\.252|\.254|\.255){0,3}$No
static_dnsListString[min: 1, max: 1024]No
vlanAnyInteger[min: 1, max: 4094] or String[matches: `(?:[1-9][1-9][0-9][1-9][0-9]2
wanChoicedisabled, enabled, not configuredNo

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

NameTypeConstraintMandatoryDefault Value
using_static_ipBooleantrue, falseNo
static_ipIPNo
static_gateway_ipIPNo
static_subnet_maskStringRegex: ^(255|254|252|248|240|224|192|128|0+)(\.0|\.128|\.192|\.224|\.240|\.248|\.252|\.254|\.255){0,3}$No
static_dnsListString[min: 1, max: 1024]No
vlanAnyInteger[min: 1, max: 4094] or String[matches: `(?:[1-9][1-9][0-9][1-9][0-9]2
wanChoicedisabled, enabled, not configuredNo

ports (meraki.domains.organizations.networks.devices.switch)

NameTypeConstraintMandatoryDefault Value
nameStringmin: 1, max: 127No
tagsListString[min: 1, max: 255]No
enabledBooleantrue, falseNo
typeChoiceaccess, routed, stack, trunkNo
vlanAnyInteger[min: 1, max: 4094] or String[matches: `(?:[1-9][1-9][0-9][1-9][0-9]2
voice_vlanAnyInteger[min: 1, max: 4094] or String[matches: `(?:[1-9][1-9][0-9][1-9][0-9]2
allowed_vlansAnyInteger[min: 1, max: 4094] or String[matches: `(?:[1-9][1-9][0-9][1-9][0-9]2
stp_guardChoicebpdu guard, disabled, loop guard, root guardNo
link_negotiationStringmin: 1, max: 127No
udldChoiceAlert only, EnforceNo
access_policy_typeChoiceCustom access policy, MAC allow list, Open, Sticky MAC allow listNo
mac_allow_listListMACNo
sticky_mac_allow_listListMACNo
sticky_mac_allow_list_limitIntegermin: 1, max: 10No
peer_sgt_capableBooleantrue, falseNo
dai_trustedBooleantrue, falseNo
profileClass[profile]No
dot3azBooleantrue, falseNo
poeBooleantrue, falseNo
isolationBooleantrue, falseNo
rstpBooleantrue, falseNo
storm_controlBooleantrue, falseNo
flexible_stackingBooleantrue, falseNo
port_idsStringRegex: \d{1,3}No
port_schedule_nameStringmin: 1, max: 127No
access_policy_nameStringmin: 1, max: 127No
adaptive_policy_group_nameStringmin: 1, max: 127No

routing_interfaces_dhcp (meraki.domains.organizations.networks.devices.switch)

NameTypeConstraintMandatoryDefault Value
dhcp_modeChoicedhcpDisabled, dhcpRelay, dhcpServerNo
dhcp_relay_server_ipsListIPNo
dhcp_lease_timeChoice1 day, 1 hour, 1 week, 12 hours, 30 minutes, 4 hoursNo
dns_nameservers_optionChoicecustom, googlePublicDns, openDnsNo
dns_custom_nameserversListIPNo
boot_next_serverIPNo
boot_file_nameStringmin: 1, max: 127No
dhcp_optionsList[dhcp_options]No
reserved_ip_rangesList[reserved_ip_ranges]No
fixed_ip_assignmentsList[fixed_ip_assignments]No
boot_optionsBooleantrue, falseNo

routing_static_routes (meraki.domains.organizations.networks.devices.switch)

NameTypeConstraintMandatoryDefault Value
nameStringmin: 1, max: 127No
subnetStringRegex: ^((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_ipIPNo
advertise_via_ospfBooleantrue, falseNo
prefer_over_ospf_routesBooleantrue, falseNo
management_next_hopIPNo

warm_spare (meraki.domains.organizations.networks.devices.switch)

NameTypeConstraintMandatoryDefault Value
enabledBooleantrue, falseYes
spare_deviceAnyString[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)

NameTypeConstraintMandatoryDefault Value
areaAnyString[min: 1, max: 13] or IP or Integer[min: 1, max: 4294967295]No
costIntegermin: 1, max: 65535No
is_passiveBooleantrue, falseNo

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

NameTypeConstraintMandatoryDefault Value
assignment_modeChoiceeui-64, staticNo
prefixStringmin: 1, max: 1024No
addressStringmin: 1, max: 1024No
gatewayIPNo

alternate_management_interface_ipv6 (meraki.domains.organizations.networks.devices.wireless)

NameTypeConstraintMandatoryDefault Value
protocolChoiceipv4, ipv6No
assignment_modeChoicedynamic, staticNo
addressStringmin: 1, max: 1024No
gatewayIPNo
prefixStringmin: 1, max: 1024No
nameserversListIPNo

bluetooth_settings (meraki.domains.organizations.networks.devices.wireless)

NameTypeConstraintMandatoryDefault Value
uuidStringRegex: ^[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
majorIntegermin: 0, max: 31No
minorIntegermin: 0, max: 125No

electronic_shelf_label (meraki.domains.organizations.networks.devices.wireless)

NameTypeConstraintMandatoryDefault Value
channelStringNo
enabledBooleantrue, falseNo

radio_settings (meraki.domains.organizations.networks.devices.wireless)

NameTypeConstraintMandatoryDefault Value
two_four_ghz_settingsClass[two_four_ghz_settings]No
five_ghz_settingsClass[five_ghz_settings]No
rf_profile_nameStringmin: 1, max: 127No

two_four_ghz_settings (meraki.domains.organizations.networks.devices.appliance.radio_settings)

NameTypeConstraintMandatoryDefault Value
channelChoice1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13No
target_powerIntegermin: 2, max: 30No

five_ghz_settings (meraki.domains.organizations.networks.devices.appliance.radio_settings)

NameTypeConstraintMandatoryDefault Value
channelChoice36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140, 144, 149, 153, 157, 161, 165No
channel_widthChoice0, 20, 40, 80, 160No
target_powerIntegermin: 2, max: 30No

NameTypeConstraintMandatoryDefault Value
enabledBooleantrue, falseNo
vlan_taggingClass[vlan_tagging]No
svisClass[svis]No
pppoeClass[pppoe]No

NameTypeConstraintMandatoryDefault Value
enabledBooleantrue, falseNo
vlan_taggingClass[vlan_tagging]No
svisClass[svis]No
pppoeClass[pppoe]No

parameters (meraki.domains.organizations.networks.devices.camera.custom_analytics)

NameTypeConstraintMandatoryDefault Value
nameStringmin: 1, max: 127Yes
valueStringmin: 1, max: 127Yes

apns (meraki.domains.organizations.networks.devices.cellular_sims.sims)

NameTypeConstraintMandatoryDefault Value
nameStringmin: 1, max: 127Yes
allowed_ip_typesListChoice[ipv4, ipv6, IPV4, IPV6]Yes
authenticationClass[authentication]No

reserved_ip_ranges (meraki.domains.organizations.networks.devices.cellular_gateway.lan)

NameTypeConstraintMandatoryDefault Value
startIPYes
endIPYes
commentStringmin: 1, max: 127Yes

fixed_ip_assignments (meraki.domains.organizations.networks.devices.cellular_gateway.lan)

NameTypeConstraintMandatoryDefault Value
nameStringmin: 1, max: 127No
ipIPYes
macMACYes

profile (meraki.domains.organizations.networks.devices.switch.ports)

NameTypeConstraintMandatoryDefault Value
enabledBooleantrue, falseNo
inameStringmin: 1, max: 127No
nameStringmin: 1, max: 127No

dhcp_options (meraki.domains.organizations.networks.devices.switch.routing_interfaces_dhcp)

NameTypeConstraintMandatoryDefault Value
codeStringRegex: ^([2-9]|1[0-9][0-9]?|2[0-9]|2[0-5][0-4]|[3-9][0-9])$Yes
typeChoicehex, integer, ip, textYes
valueStringmin: 1, max: 127Yes

reserved_ip_ranges (meraki.domains.organizations.networks.devices.switch.routing_interfaces_dhcp)

NameTypeConstraintMandatoryDefault Value
startIPYes
endIPYes
commentStringmin: 1, max: 127No

fixed_ip_assignments (meraki.domains.organizations.networks.devices.switch.routing_interfaces_dhcp)

NameTypeConstraintMandatoryDefault Value
nameStringmin: 1, max: 127Yes
macMACYes
ipIPYes

two_four_ghz_settings (meraki.domains.organizations.networks.devices.wireless.radio_settings)

NameTypeConstraintMandatoryDefault Value
channelChoice1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13No
target_powerIntegermin: 2, max: 30No

five_ghz_settings (meraki.domains.organizations.networks.devices.wireless.radio_settings)

NameTypeConstraintMandatoryDefault Value
channelChoice36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140, 144, 149, 153, 157, 161, 165No
channel_widthChoice0, 20, 40, 80, 160No
target_powerIntegermin: 2, max: 30No

NameTypeConstraintMandatoryDefault Value
enabledBooleantrue, falseNo
vlan_idAnyInteger[min: 1, max: 4094] or String[matches: `(?:[1-9][1-9][0-9][1-9][0-9]2

NameTypeConstraintMandatoryDefault Value
ipv4Class[ipv4]No
ipv6Class[ipv6]No

NameTypeConstraintMandatoryDefault Value
enabledBooleantrue, falseNo
authenticationClass[authentication]No

NameTypeConstraintMandatoryDefault Value
enabledBooleantrue, falseNo
vlan_idAnyInteger[min: 1, max: 4094] or String[matches: `(?:[1-9][1-9][0-9][1-9][0-9]2

NameTypeConstraintMandatoryDefault Value
ipv4Class[ipv4]No
ipv6Class[ipv6]No

NameTypeConstraintMandatoryDefault Value
enabledBooleantrue, falseNo
authenticationClass[authentication]No

authentication (meraki.domains.organizations.networks.devices.cellular_sims.sims.apns)

NameTypeConstraintMandatoryDefault Value
typeChoicechap, none, papNo
usernameStringmin: 1, max: 127No
passwordStringmin: 5, max: 64No

NameTypeConstraintMandatoryDefault Value
assignment_modeChoicedynamic, staticNo
addressStringmin: 1, max: 1024No
gatewayIPNo
nameserversListIPNo

NameTypeConstraintMandatoryDefault Value
assignment_modeChoicedynamic, staticNo
addressStringmin: 1, max: 1024No
gatewayIPNo
nameserversListIPNo

NameTypeConstraintMandatoryDefault Value
enabledBooleantrue, falseNo
usernameStringmin: 1, max: 127No
passwordStringmin: 5, max: 64No

NameTypeConstraintMandatoryDefault Value
assignment_modeChoicedynamic, staticNo
addressStringmin: 1, max: 1024No
gatewayIPNo
nameserversListIPNo

NameTypeConstraintMandatoryDefault Value
assignment_modeChoicedynamic, staticNo
addressStringmin: 1, max: 1024No
gatewayIPNo
nameserversListIPNo

NameTypeConstraintMandatoryDefault Value
enabledBooleantrue, falseNo
usernameStringmin: 1, max: 127No
passwordStringmin: 5, max: 64No

Examples

Example-1: The example below demonstrates basic device configuration for a small branch office with essential device properties including serial numbers, location data, and organizational tags.

meraki:
domains:
- name: "!env domain"
administrator:
name: "!env org_admin"
organizations:
- name: "!env org"
networks:
- name: "!env network_name"
product_types:
- appliance
- switch
- wireless
devices:
- name: "Branch-MX-01"
serial: "Q2XX-XXXX-XXXX"
tags:
- branch
- primary
lat: 37.4180951
lng: -122.0985314
address: "123 Main Street, San Francisco, CA"
notes: "Primary security appliance for branch office"
- name: "Branch-SW-01"
serial: "Q2YY-YYYY-YYYY"
tags:
- branch
- access
lat: 37.4180951
lng: -122.0985314
address: "123 Main Street, San Francisco, CA"
notes: "Access switch for branch office"

Configuration Parameters

ParameterTypeRequiredDescription
nameStringYesHuman-readable device name for identification
serialStringYesDevice serial number (must match physical device)
tagsArrayNoOrganizational tags for device grouping and management
latFloatNoLatitude coordinate for device location mapping
lngFloatNoLongitude coordinate for device location mapping
addressStringNoPhysical address where device is installed
notesStringNoAdministrative notes for device documentation
switch_profile_nameStringNoSwitch profile to apply (switches only)
floor_plan_nameStringNoFloor plan assignment for location visualization