Skip to main content
CloudEnterprise

Technical Information

Cisco Meraki to NetBox Object Mapping

This document provides a comprehensive mapping of Cisco Meraki object types to their corresponding NetBox object types, based on the integration implementation.

Object Type Mapping Table

Cisco Meraki ObjectNetBox Object TypeKey Fields MappedMapping Details
OrganizationTenantnamename
iddescription
nameslugMaps Meraki organization to NetBox tenant with descriptive naming and ID preservation.
NetworkSitenamename
nameslug
idcustom_fields.meraki_network_id
tagstagsMaps Meraki networks to NetBox sites with network ID preservation and tag inheritance.
Device (Inventory)Devicename or serialname
serialserial
modeldevice_type.model
firmwareplatform.name
tagstagsMaps Meraki devices to NetBox devices with hardware details, firmware information, and tag inheritance.
Device TypeDeviceTypemodelmodel
StaticmanufacturerCreates device types based on Meraki device model with Cisco as manufacturer.
Device RoleDeviceRolemodel prefix → nameMaps Meraki device model prefixes (MR, MS, MX) to NetBox device roles.
PlatformPlatformmodel + firmwarename
StaticmanufacturerCreates platforms based on device model and firmware version.
ManufacturerManufacturerStaticnameAlways set to "Cisco" for all Meraki devices.
Wireless LANWirelessLANnamessid
enabledstatus
authModeauth_type
encryptionModeauth_cipher
scope_sitescope_siteMaps Meraki SSIDs to NetBox wireless LANs with authentication and encryption details.
VLANVLANidvid
namename
StaticstatusMaps Meraki appliance VLANs to NetBox VLANs with active status.
VLAN GroupVLANGroupnetwork.namename
scope_sitescope_siteCreates VLAN groups scoped to sites for each Meraki network.
InterfaceInterfacenamename
enabledenabled
typetype
descriptiondescriptionMaps Meraki device interfaces to NetBox interfaces with configuration details.
IP AddressIPAddressip + subnetaddress
assigned_objectassigned_objectMaps Meraki IP configurations to NetBox IP addresses in CIDR notation.
MAC AddressMACAddressmacmac_address
assigned_objectassigned_objectMaps Meraki device MAC addresses to NetBox MAC address objects.

Field Mapping Details

Device Status Mapping

Meraki Device StatusNetBox Status
In inventoryactive
Any other statusactive

Wireless LAN Status Mapping

Meraki SSID StatusNetBox Status
true (enabled)active
false (disabled)disabled

Device Role Mapping

Meraki Model PrefixNetBox Device Role
MRWireless AP
MSSwitch
MXFirewall

Authentication Type Mapping

Meraki Auth ModeNetBox Auth Type
openopen
pskwpa-personal
8021x-merakiwpa-enterprise
8021x-radiuswpa-enterprise
ipsk-with-radiuswpa-enterprise
Any other valueopen

Authentication Cipher Mapping

Meraki Encryption ModeNetBox Auth Cipher
wepwep
wpatkip
wpa-eaptkip
wpa2aes
wpa2-eapaes
openauto
Any other valueauto

Interface Type Mapping

Meraki Device TypeInterface Types Created
MR (Wireless AP)Radio interfaces (2.4GHz, 5GHz, 6GHz)
MS (Switch)Physical switch ports
MX (Firewall)Appliance ports and VLAN interfaces

VLAN Status Mapping

Meraki VLAN StatusNetBox Status
All VLANs from APIactive

Data Flow

  1. Authentication: Establishes connection to Meraki Dashboard API using organization API key
  2. Organization Discovery: Creates tenant based on organization data
  3. Network Discovery: Fetches all networks from Meraki organization and creates NetBox sites
  4. VLAN Group Creation: Creates VLAN groups scoped to each site/network
  5. VLAN Discovery: Fetches appliance VLAN configurations and creates NetBox VLANs
  6. Wireless LAN Discovery: Processes SSID configurations from wireless networks
  7. Device Discovery: Retrieves organization devices and creates device entities with roles and types
  8. Interface Creation: Creates interfaces based on device type (radios, ports, VLAN interfaces)
  9. IP Address Processing: Creates management IPs and VLAN gateway IPs
  10. MAC Address Association: Links MAC addresses to interfaces
  11. Primary IP Assignment: Sets primary IPv4/IPv6 on devices
  12. Data Ingestion: Sends entities to NetBox via Diode for processing

Custom Fields

The integration requires and utilizes several custom fields:

Custom FieldObject TypePurpose
meraki_network_idSiteStores Meraki network ID for reference

Tags and Metadata

All objects created by the integration are tagged with:

  • cisco
  • meraki
  • discovered

Additional tags from Meraki networks and devices are preserved and added to the tag list.

Notes

  • Device Naming: Devices are named using the Meraki name field, falling back to serial if name is empty
  • Serial Number Handling: Uses Meraki serial field as NetBox device serial number
  • Platform Creation: Platforms are created based on device model and firmware version
  • Interface Management: Creates different interface types based on device role (radios for APs, ports for switches, etc.)
  • VLAN Processing: Only processes networks with appliance capabilities for VLAN creation
  • Wireless LAN Processing: Only processes networks with wireless capabilities for SSID creation
  • IP Address Handling: Creates management IPs and VLAN gateway IPs with proper CIDR notation
  • Rate Limiting: Integration uses Meraki SDK with built-in rate limiting and retry logic
  • Device Filtering: Only processes supported device types (MR, MS, MX) and ignores others
  • Primary IP Assignment: Automatically assigns first IPv4/IPv6 addresses as primary IPs on devices