Skip to main content
CloudEnterprise

Technical Information

Infoblox NIOS to NetBox Object Mapping

Object Type Mapping Table

Infoblox NIOS ObjectNetBox ObjectKey Attributes
Network ViewTagname as infoblox-network-view:{name}; applied to all objects in that view
Network (IPv4 / IPv6)Prefixnetworkprefix, commentdescription, status "active", network view tag, custom_fields.infoblox_vlans
Network ContainerPrefixnetworkprefix, commentdescription, status "active", tagged network-container
DHCP Range (IPv4 / IPv6)PrefixCIDR calculated from start_addr/end_addr, status "active", tagged dhcp-range, role:dhcp
Fixed AddressIPAddressipv4addr/ipv6addraddress, namedns_name, status "dhcp" or "reserved", custom_fields.infoblox_match_client, custom_fields.infoblox_agent_circuit_id, custom_fields.infoblox_agent_remote_id
DHCP LeaseIPAddressaddress, client_hostnamedns_name, status "dhcp"
Host RecordIPAddressipv4addraddress, hostname → dns_name, status "active"
VLANVLANidvid, name, status (ASSIGNED/UNASSIGNED → "active", RESERVED → "reserved")
VLAN ViewVLANGroupname, description, vid_ranges, scope_site (from extattrs.Site)

Field Mapping Details

Prefix Status Mapping

Infoblox Object TypeNetBox StatusNotes
Network containeractiveTagged with network-container
Network (IPv4/IPv6)activeTagged with has_dhcp_ranges
DHCP rangeactiveTagged with dhcp-range and role:dhcp

IP Address Status Mapping

Infoblox Object TypeNetBox StatusCondition
DHCP LeasedhcpAlways
Fixed AddressdhcpWhen match_client is MAC_ADDRESS, CLIENT_ID, CIRCUIT_ID, or REMOTE_ID
Fixed AddressreservedWhen match_client is RESERVED, missing, or invalid
Host RecordactiveAlways

VLAN Status Mapping

Infoblox VLAN StatusNetBox Status
ASSIGNEDactive
UNASSIGNEDactive
RESERVEDreserved

Network View to Tag Mapping

Network views in Infoblox are mapped to NetBox tags for filtering and organization:

Network ViewNetBox Tag
Any network viewinfoblox-network-view:{view_name}

All objects (prefixes, IP addresses) are tagged with their network view for easy filtering.

VLAN View to VLAN Group Mapping

VLAN views in Infoblox are separate from network views and map to VLAN groups in NetBox:

VLAN ViewNetBox VLAN Group
Any VLAN viewVLAN Group with name {view_name} VLANs and slug {view_name}-vlans

Custom Fields

Custom FieldObject TypePurpose
infoblox_match_clientIPAddressDHCP client matching identifier
infoblox_agent_circuit_idIPAddressDHCP relay agent circuit ID
infoblox_agent_remote_idIPAddressDHCP relay agent remote ID
infoblox_vlansPrefixJSON object containing VLAN associations from Infoblox

Policy Configuration

Config Parameters

  • BOOTSTRAP (optional): When true, only static entities (custom fields, tags) are created; no API calls. Default: false.
  • INFOBLOX_HOST (required when not BOOTSTRAP): Infoblox NIOS Grid Master hostname or IP address.
  • INFOBLOX_USER (required when not BOOTSTRAP): Infoblox NIOS username for authentication.
  • INFOBLOX_PWD (required when not BOOTSTRAP): Infoblox NIOS password for authentication.
  • INFOBLOX_VERSION (optional): WAPI version to use. Default: 2.11.
  • INFOBLOX_SSL_VERIFY (optional): Enable/disable SSL certificate verification. Default: false.
  • INFOBLOX_SYNC_LEASES (optional): When true, DHCP leases are synced as IPAddress objects with status dhcp. Default: false. Leases can be numerous and short-lived; enable only when lease visibility in NetBox is required.

Scope Parameters

  • network_views (optional): List of network view names to ingest.

    • Default: ["*"] (all network views)
    • Use ["*"] to ingest all network views
    • Specify individual views: ["default", "prod", "dev"]
    • Empty list [] defaults to all network views
    • Invalid names cause validation error after fetching available views
  • network_to_dns_view_mapping (optional): Custom mapping of network views to DNS views for host record queries.

    • Format: {"network_view_name": "dns_view_name"}
    • Default behavior if not specified:
      • default network view → default DNS view
      • Other network views → default.{network_view} DNS view
    • Example: {"prod": "prod-dns", "dev": "dev-dns"}
  • site_ea_name (optional): Name of the Infoblox Extensible Attribute used to derive the NetBox Site for prefixes and VLAN groups. Default: "Site". Set this if your EA that holds site names has a different name (for example "Location" or "NetBox_Site").

  • ea_tags (optional): List of Extensible Attribute names whose values are emitted as NetBox tags on the form ea:\{name\}:{value}. Default: [] (no EA tags). Use this to propagate Infoblox metadata into NetBox tags for filtering. Example: ["Environment", "Owner"] produces tags like ea:Environment:prod and ea:Owner:network-team.

Tags and Metadata

Global Tags

All created entities are automatically tagged with:

  • infoblox - Identifies objects from Infoblox NIOS
  • discovered - Marks objects as auto-discovered
  • infoblox-{hostname} - Unique tag per Infoblox host (not applied in bootstrap mode)

Object-Specific Tags

Prefixes:

  • infoblox-network-view:{view_name} - Network view membership
  • network-container - Identifies network containers
  • has_dhcp_ranges - Identifies networks with DHCP ranges
  • dhcp-range - Identifies DHCP range prefixes
  • role:dhcp - Role tag for DHCP ranges

IP Addresses:

  • infoblox-network-view:{view_name} - Network view membership
  • dhcp-configured - Host records with DHCP enabled

VLANs:

  • infoblox-vlan-view:{view_name} - VLAN view membership
  • infoblox-vlan-range:{range_name} - VLAN range membership (if in a range)
  • infoblox-vlan-status:{status} - Original Infoblox status (ASSIGNED, UNASSIGNED, RESERVED)
  • infoblox-vlan-reserved - Reserved flag is set

API and Behavior Notes

  • APIs used: Infoblox WAPI endpoints including:

    • network - IPv4 network objects
    • ipv6network - IPv6 network objects
    • networkcontainer - Network containers
    • fixedaddress - IPv4 DHCP fixed addresses
    • ipv6fixedaddress - IPv6 DHCP fixed addresses
    • lease - DHCP leases
    • record:host_ipv4addr - Host records
    • range - IPv4 DHCP ranges
    • ipv6range - IPv6 DHCP ranges
    • vlan - VLANs
    • vlanview - VLAN views
    • vlanrange - VLAN ranges
    • networkview - Network views
  • Network view filtering: Objects are synchronized based on configured network views:

    • By default, all network views are synchronized (["*"])
    • Explicit list restricts to specified views
    • Invalid view names cause validation error
    • Each network view is queried separately to ensure complete data collection
  • DNS view mapping: Host records are queried using DNS views:

    • Network views are mapped to DNS views for record:host_ipv4addr queries
    • Default convention: defaultdefault, others → default.{network_view}
    • Custom mappings can be configured via network_to_dns_view_mapping scope parameter
  • DHCP synchronization:

    • Fixed addresses (reservations) are created as IPAddress objects
      • Status: dhcp (if match_client is set) or reserved
      • Match type stored in infoblox_match_client custom field
      • Agent circuit/remote IDs stored in custom fields when applicable
    • DHCP ranges are created as Prefix objects with dhcp-range and role:dhcp tags
    • Range CIDR is calculated using address summarization
  • Hostname handling:

    • The dns_name field on IPAddress objects is populated from:
      • Fixed address name field
      • Host record (record:host_ipv4addr) hostname
      • DHCP lease client_hostname field
    • This is metadata associated with DHCP/IPAM objects, not DNS zone data
  • Network containers:

    • Network containers maintain hierarchical structure in NetBox
    • Status is set to active (not container)
    • Tagged with network-container for identification
    • Child networks reference parent containers through prefix hierarchy
  • VLAN associations:

    • Networks can be associated with VLANs in Infoblox
    • VLAN associations are stored in the infoblox_vlans custom field as JSON
    • Format: [{"id": 100, "name": "Data VLAN"}, ...]
  • Site extraction:

    • Sites are extracted from Infoblox extensible attributes
    • Attribute name: Site
    • Applied to prefixes and VLAN groups