Skip to main content

NetBox Integration

The NetBox connector keeps ServiceRadar's registry synchronized with your source-of-truth CMDB. It imports devices, IP addresses, and services, then seeds discovery sweeps and monitoring profiles.

Requirements

  • NetBox 3.5+ with API access enabled.
  • A service account token scoped to read device, IPAM, and virtualization objects.
  • Outbound HTTPS connectivity from the Sync service to your NetBox deployment.

Configuration Steps

  1. Add the NetBox block to your Sync configuration:

    {
    "integrations": {
    "netbox": {
    "type": "netbox",
    "endpoint": "https://netbox.example.com/api",
    "prefix": "netbox/",
    "credentials": {
    "api_token": "${kv:secrets/netbox/api_token}",
    "expand_subnets": "true"
    },
    "partition": "default"
    }
    }
    }
  2. Store the API token securely in KV (see KV configuration).

  3. Redeploy or restart serviceradar-sync. Tail kubectl logs deploy/serviceradar-sync -n demo and look for netbox_sync entries confirming pulls.

How Data Flows

  • Devices and VMs become registry entries tagged with source=netbox.
  • Prefixes and IP addresses translate into sweep jobs, which pollers pick up automatically (see Discovery Guide).
  • Site, tenant, and device-role metadata convert into labels that surface in SRQL and dashboards.

Advanced Options

OptionDescriptionDefault
expand_subnetsExpand prefixes into host entries rather than treating them as /32 hosts.false
insecure_skip_verifySkip TLS validation when using self-signed certs. Combine with the Self-Signed Certificates guide.false
partitionOverride the destination registry partition.default

Validation

  • Run in:devices source:netbox sort:hostname limit:20 in SRQL to confirm imports.
  • Compare interface counts against NetBox inventory; mismatches usually stem from stale caching.
  • Use the Service Port Map to confirm Layer 2/3 relationships were derived correctly.

Troubleshooting

  • Permission errors indicate insufficient API scopes—Double-check the service account roles.
  • Large imports can breach NetBox rate limits. Set page_size in the config block or enable result caching in Sync.
  • See the Troubleshooting Guide for remediation tips and log locations.