How tkdebnath/netbox-meraki works
NetBox Meraki Sync imports Cisco Meraki Dashboard data into NetBox. The main workflow is to initiate a sync, retrieve organization and network data through the Meraki client, process infrastructure domains, and apply changes immediately, stage them for review, or preview them in dry-run mode. The plugin also provides configuration and filtering, scheduled/background execution, and sync history and progress through web and REST interfaces. The excerpts show the sync service invoking the client and persisting log/review data; several domain details are documented in the README but their implementations were not sampled.
Main entry points: sync_service.py Sync orchestration · netbox_meraki/views.py Web interface · api/views.py REST API · models.py Sync history
Components 19
Entry points
- Sync command
netbox_meraki/management/commands/sync_meraki.py - Web interface
netbox_meraki/views.py - Background job
netbox_meraki/jobs.py - REST API
netbox_meraki/api/views.py
Synchronization
- Sync orchestration
netbox_meraki/sync_service.py - Meraki API client
netbox_meraki/meraki_client.py - Networks and devices
netbox_meraki/sync_service.py - VLANs and prefixes
netbox_meraki/sync_service.py - Wireless LANs
netbox_meraki/sync_service.py - Interfaces
netbox_meraki/sync_service.py
Configuration and review
- Sync settings
netbox_meraki/models.py - Naming and filters
netbox_meraki/models.py - Review staging
netbox_meraki/models.py - NetBox and plugin records
netbox_meraki/models.py
Status and interfaces
- Sync history
netbox_meraki/models.py - Configuration forms
netbox_meraki/forms.py - Log serializer
netbox_meraki/api/serializers.py
Other components
- NetBox operator
- Meraki Dashboard
Connections 24
- NetBox operator → Sync command: runs
netbox_meraki/management/commands/sync_meraki.py - NetBox operator → Web interface: manages
- NetBox operator → REST API: requests
- Sync command → Sync orchestration: starts sync
netbox_meraki/management/commands/sync_meraki.py - Web interface → Sync orchestration: starts sync
netbox_meraki/views.py - Web interface → Background job: schedules
netbox_meraki/views.py - Background job → Sync orchestration: runs sync
netbox_meraki/jobs.py - REST API → Sync orchestration: starts sync
netbox_meraki/api/views.py - Sync orchestration → Meraki API client: requests data
netbox_meraki/sync_service.py - Meraki API client → Meraki Dashboard: fetches
netbox_meraki/meraki_client.py - Sync orchestration → Networks and devices: syncs
README.md - Sync orchestration → VLANs and prefixes: syncs
README.md - Sync orchestration → Wireless LANs: syncs
README.md - Sync orchestration → Interfaces: syncs
README.md - Sync orchestration → NetBox and plugin records: applies changes
README.md - Sync orchestration → Review staging: stages changes
netbox_meraki/sync_service.py - Sync orchestration → Sync history: records progress
netbox_meraki/sync_service.py - Sync settings → Sync orchestration: configures
netbox_meraki/models.py - Naming and filters → Sync orchestration: filters and transforms
netbox_meraki/models.py - Configuration forms → Sync settings: edits
netbox_meraki/forms.py - Web interface → Configuration forms: uses
netbox_meraki/views.py - REST API → Sync history: reads logs
netbox_meraki/api/views.py - REST API → Log serializer: serializes logs
netbox_meraki/api/views.py - Log serializer → Sync history: serializes
netbox_meraki/api/serializers.py