Skip to content

Data Mapping

Note

This information is based on the latest version of the IP Fabric NetBox plugin.

This document outlines the tables from IP Fabric that are imported into NetBox and their corresponding endpoints, including the specific properties that are mapped.

Data Sources

IP Fabric Table IP Fabric Endpoint NetBox Model NetBox App
Sites /inventory/sites/overview Site dcim
Devices /inventory/devices Device dcim
Virtual Chassis /technology/platforms/stack/members + /technology/platforms/vss/chassis VirtualChassis dcim
Interfaces /inventory/interfaces Interface dcim
Part Numbers /inventory/part-numbers InventoryItem dcim
VLANs /technology/vlans/site-summary VLAN ipam
VRFs /technology/routing/vrf/detail VRF ipam
Networks /technology/networks/managed-networks Prefix ipam
IP Addresses /technology/addressing/managed-ip/ipv4 + /technology/addressing/managed-ip/ipv6 IPAddress ipam

Property Mappings

Site

IP Fabric Property NetBox Property
siteName name
siteName slug
N/A cf_ipfabric_source
N/A cf_ipfabric_ingestion

Device

IP Fabric Property NetBox Property
hostname name
N/A status (always active)
sn serial
siteName site (relationship)
model device_type (relationship)
devType role (relationship)
virtual_chassis.member vc_position
virtual_chassis virtual_chassis (relationship)
N/A cf_ipfabric_source
N/A cf_ipfabric_ingestion

Manufacturer

IP Fabric Property NetBox Property
vendor name
vendor slug

Device Type

IP Fabric Property NetBox Property
model model
model slug
vendor manufacturer (relationship)

Device Role

IP Fabric Property NetBox Property
devType name
devType slug
N/A vm_role (set to False)

Platform

IP Fabric Property NetBox Property
family or vendor name
vendor + family slug
vendor manufacturer (relationship)

Interface

IP Fabric Property NetBox Property
nameOriginal or intName name
dscr description
mtu mtu
media type
l1 enabled
primaryIp + loginIp mgmt_only
speedValue speed
duplex duplex
sn device (relationship)

Interface Assignment for Virtual Chassis / Stacks

For devices that are part of a Virtual Chassis (stacks or VSS chassis), all interfaces from all member devices are currently assigned to the master device only in NetBox. This occurs because IP Fabric’s /inventory/interfaces endpoint provides the master device’s serial number in the sn field for all interfaces across all stack members.

Behavior:

  • Each stack/VSS member is created as a separate Device in NetBox (e.g., hostname/1, hostname/2)
  • All member devices are linked to a VirtualChassis object
  • However, all interfaces are assigned to the master device (the one with member serial matching the master serial)

MAC Address

IP Fabric Property NetBox Property
mac mac_address
id assigned_object_id
N/A assigned_object_type (set to Interface)

Inventory Item

IP Fabric Property NetBox Property
pid part_id
sn serial
name or dscr name
deviceSn device (relationship)
vendor manufacturer (relationship)

VLAN

IP Fabric Property NetBox Property
vlanName name
dscr description
vlanId vid
siteName site (relationship)

VRF

IP Fabric Property NetBox Property
vrf name
rd rd

Prefix

IP Fabric Property NetBox Property
net prefix
siteName scope_id
vrf vrf (relationship)
N/A scope_type (set to Site)

IP Address

IPv4 addresses are sourced from /technology/addressing/managed-ip/ipv4 and IPv6 addresses from /technology/addressing/managed-ip/ipv6. Both tables share an identical column schema and are merged into a single list before processing — no separate Transform Map or configuration is needed.

IP Fabric Property NetBox Property
ip + net address (mask taken from net; defaults to /32 for IPv4 or /64 for IPv6 when net is absent)
sn + nameOriginal assigned_object_id
N/A assigned_object_type (set to Interface)
vrf vrf (relationship)

The device field loginIpv4 (or the legacy loginIp field present on older IP Fabric versions) drives Device.primary_ip4; loginIpv6 drives Device.primary_ip6. Both fields can be populated at the same time and are handled independently.

Virtual Chassis

Stack members (/technology/platforms/stack/members) and VSS chassis (/technology/platforms/vss/chassis) are fetched automatically together whenever Virtual Chassis or Device sync is enabled. Both are merged into a single member list before processing. Stack members carry the member serial number in memberSn; VSS chassis carry it in chassisSn. In both cases the result is a NetBox VirtualChassis object with one Device per physical member.

IP Fabric Property NetBox Property
master name
sn master (relationship to Device)

Data Transformation

Data is transformed from IP Fabric to NetBox using transform maps that define: - Source fields from IP Fabric - Target fields in NetBox - Jinja2 templates to transform source fields to target fields - Relationship mappings between models

Sync Process

  1. Data is collected from IP Fabric API
  2. Transform maps convert IP Fabric data format to NetBox format
  3. Data is synced to NetBox ingestion
  4. Data is merged from NetBox ingestion to the main database