Infoblox Integration Setup¶

This guide will walk you through the steps to set up Infoblox integration with the nautobot_ssot app.

Prerequisites¶

Before configuring the integration, please ensure, that the nautobot-ssot app was installed with the Infoblox integration extra dependencies.

pip install nautobot-ssot[infoblox]

Configuration¶

Note

Legacy configuration settings defined in the nautobot_config.py and environmental variables are deprecated. These settings are migrated on a best-effort basis on the first startup following migration to the Nautobot SSOT 2.7.0 or higher.

The integration with Infoblox utilizes External Integrations to specify your Infoblox host information. To enable this integration, the only modification needed is to activate it in the nautobot_config.py file.

Below is an example snippet from nautobot_config.py that demonstrates how to enable the Infoblox integration:

PLUGINS_CONFIG = {
    "nautobot_ssot": {
        "enable_infoblox": True,
    }
}

The remaining integration configuration is defined in the instance of the SSOTInfobloxConfig model. Multiple configuration instances are supported. Synchronization jobs take the Config parameter which specifies the configuration instance to use.

To access integration configuration navigate to Apps -> Installed Apps and click on the cog icon in the Single Source of Truth entry. Then in the table SSOT Integration Configs click on the Infoblox Configuration List link. This will take you to the view where you can view/modify existing config instances or create new ones.

Configuration instance contains the below settings. The Setting column is the model field name, as used in the REST API and in nautobot_ssot code; the UI label column is how the field is labelled in the configuration form.

Setting	UI label	Default	Description
`name`	Name	N/A (required)	Unique name of the configuration instance.
`description`	Description	`""`	Description of the configuration instance.
`infoblox_instance`	Infoblox Instance	N/A (required)	External Integration object describing remote Infoblox instance.
`infoblox_wapi_version`	Infoblox WAPI version	`v2.12`	The version of the Infoblox API.
`job_enabled`	Can be used in Sync Job	`False`	Allows this config to be used in the sync jobs.
`enable_sync_to_infoblox`	Enable Sync from Nautobot to Infoblox	`False`	Allows this config to be used in the job syncing from Nautobot to Infoblox.
`enable_sync_to_nautobot`	Enable Sync from Infoblox to Nautobot	`True`	Allows this config to be used in the job syncing from Infoblox to Nautobot.
`import_ip_addresses`	Import IP Addresses	`False`	Import IP addresses from the source to the target system.
`import_subnets`	Import Networks	`False`	Import IP networks from the source to the target system.
`import_vlan_views`	Import VLAN Views	`False`	Import VLAN Views from the source to the target system.
`import_vlans`	Import VLANs	`False`	Import VLANs from the source to the target system.
`import_ipv4`	Import IPv4	`True`	Import IPv4 objects from the source to the target system.
`import_ipv6`	Import IPv6	`False`	Import IPv6 objects from the source to the target system.
`fixed_address_type`	Fixed Address type	Do not create fixed address	Selects type of Fixed Address to create in Infoblox for imported IP Addresses.
`dns_record_type`	DNS record type	Create Host record	Selects the type of DNS record to create in Infoblox for imported IP Addresses.
`default_status`	Default Status for Imported Objects	N/A (required)	Default Status to be assigned to imported objects.
`infoblox_deletable_models`	Models that can be deleted in Infoblox	`[]`	Infoblox model types whose instances are allowed to be deleted during sync.
`nautobot_deletable_models`	Models that can be deleted in Nautobot	`[]`	Nautobot model types whose instances are allowed to be deleted during sync.
`infoblox_sync_filters`	Infoblox Sync Filters	`[{"network_view": "default"}]`	Filters control what data is loaded from the source and target systems and considered for sync.
`infoblox_network_view_to_namespace_map`	Infoblox View/Namespace mappings	`{"default": "Global"}`	Map of Infoblox Network View names to Nautobot Namespace names.
`infoblox_dns_view_mapping`	Infoblox Network View to DNS Mapping	`{}`	Map specifying Infoblox DNS View for each Network View where DNS records need to be created.
`cf_fields_ignore`	Extensible Attributes/Custom Fields to Ignore	`{"custom_fields": [], "extensible_attributes": []}`	Specifies Nautobot custom fields and Infoblox extensible attributes that are excluded from the sync.
`infoblox_location_ext_attr`	Infoblox Location Extensibility Attribute	`""` (blank)	Name of the Infoblox Extensibility Attribute whose value maps to a Nautobot Location. When set, only that attribute maps to a Location and the built-in `site`/`facility`/`location` names become ordinary custom fields. Leave blank to use the built-in names.

Each Infoblox configuration must be linked to an External Integration describing the Infoblox instance. The following External Integration fields must be defined for integration to work correctly:

Setting	Description
Remote URL	URL of the remote Infoblox instance to sync with.
Verify SSL	Toggle SSL verification when syncing data with Infoblox.
Secrets Group	Secrets Group defining credentials used when connecting to the Infoblox instance.
Timeout	How long HTTP requests to Infoblox should wait for a response before failing.

The Secrets Group linked to the Infoblox External Integration must contain password and username secrets defined as per the below:

Access Type	Secret Type
REST	Password
REST	Username

Default Configuration Created at Startup¶

When the Infoblox integration is enabled and no Infoblox configuration exists yet, Nautobot creates one automatically each time the database is ready, for example after nautobot-server migrate or nautobot-server post_upgrade. It creates:

An SSOTInfobloxConfig named InfobloxConfigDefault, with job_enabled and enable_sync_to_nautobot set to True and dns_record_type set to Create Host record.
An External Integration named DefaultInfobloxInstance, pointing at the placeholder URL https://replace.me.local.
A Secrets Group named InfobloxSSOTDefaultSecretGroup, whose username and password secrets read the NAUTOBOT_SSOT_INFOBLOX_USERNAME and NAUTOBOT_SSOT_INFOBLOX_PASSWORD environment variables.

Values from the deprecated nautobot_config.py settings (for example infoblox_url) are copied into these objects when present.

Warning

Review the default configuration before running a sync job: update the External Integration's Remote URL and the credentials, or disable the default configuration. If you delete every Infoblox configuration, the default configuration is recreated the next time the database is ready. To stop that, keep at least one configuration of your own.

Configuring Infoblox Sync Filters¶

Infoblox Sync Filters is a mandatory setting used to control the scope of the IP objects that are loaded from Nautobot and Infoblox. Only these objects are in the scope of the synchronization process. The default value of this setting is:

[
    {
        "network_view": "default"
    }
]

This default value specifies that all IPv4 and IPv6 objects located in Infoblox "default" Network View or Nautobot "Global" Namespace, will be loaded for comparison and considered for synchronization.

Infoblox Sync Filters can contain multiple entries. Each entry is a dictionary with one mandatory key network_view and two optional keys prefixes_ipv4 and prefixes_ipv6.

network_view specifies the name of the Infoblox Network View/Nautobot Namespace from which to load IP objects. There can be only one filter entry per network view name.
prefixes_ipv4 (optional) - a list of top-level IPv4 prefixes from which to load IPv4 networks and IP addresses. This applies to both Infoblox and Nautobot. If this key is not defined, all IPv4 addresses within the given namespace are allowed to be loaded.
prefixes_ipv6 (optional) - a list of top-level IPv6 prefixes from which to load IPv6 networks and IP addresses. This applies to both Infoblox and Nautobot. If this key is not defined, all IPv6 addresses within the given namespace are allowed to be loaded.

Below is an example showing three filters used for filtering loaded data:

[
    {
        "network_view": "default"
    },
    {
        "network_view": "dev",
        "prefixes_ipv4": [
            "192.168.0.0/16"
        ]
    },
    {
        "network_view": "test",
        "prefixes_ipv4": [
            "10.0.0.0/8"
        ],
        "prefixes_ipv6": [
            "2001:5b0:4100::/40"
        ]
    }
]

The above filters will allow the loading of the following data from Infoblox and Nautobot:

All IPv4 and IPv6 prefixes and IP addresses in the Infoblox network view "default" and Nautobot namespace "Global".
Only IPv4 prefixes and IP addresses, contained within the 192.168.0.0/16 container, located in Infoblox network view "dev" and Nautobot namespace "dev". All IPv6 prefixes and IP addresses in the Infoblox network view "dev" and Nautobot namespace "dev".
Only IPv4 prefixes and IP addresses, contained within the 10.0.0.0/8 container, located in Infoblox network view "test" and Nautobot namespace "test". Only IPv6 prefixes and IP addresses contained withing the 2001:5b0:4100::/40 container that are located in the Infoblox network view "test" and Nautobot namespace "test".

Configuring Infoblox Network Views to Nautbot Namespace map¶

This setting allows you to create mappings between Infoblox network views and Nautobot namespaces. By default, the default network view maps to the Global Nautobot namespace.

The purpose of this setting is to provide flexibility, enabling you to:

Assign a different namespace instead of Global for the default Infoblox network view.
Define additional mappings based on your environment’s requirements.

The setting is represented as a dictionary, where the keys are Infoblox network views, and the values are the corresponding Nautobot namespaces.

{
    "default": "Global"
}

Configuring Infoblox DNS View Mapping¶

Infoblox DNS View Mapping is an optional setting that tells Infoblox SSOT where to create DNS Host, A, and PTR records. Infoblox allows multiple DNS Views to be defined for one Network View. If no mappings are configured the application will create DNS records in the default DNS View associated with the Network View, usually named default.{network_view_name}, where network_view_name is the name of the parent Network View.

To define mapping specify the name of the Network View as the key and the name of the DNS View as the value. For example:

{
    "dev": "dev view",
    "default": "corporate",
}

The above configuration will create DNS records linked to Network View "dev" in the "dev view" DNS View and records linked to Network View "default" in the "corporate" DNS View.

Configuring Extensible Attributes/Custom Fields to Ignore¶

Extensible Attributes/Custom Fields to Ignore setting allows specifying Infoblox Extensible Attributes and Nautobot Custom Fields that are excluded from the synchronization. This stops unwanted extra data that is used for other purposes from being propagated between the systems.

The default value of this setting is:

{
    "extensible_attributes": [],
    "custom_fields": []
}

That is, by default, all of the extensible attributes and custom fields will be synchronized, except the custom fields used internally by the Infoblox integration.

To exclude Infoblox extensible attributes from being synchronized to Nautobot add the attribute names to the extensible_attributes list. Either form of the name works: the name as returned by the Infoblox API (for example Site Code), or the Nautobot custom field key the integration creates for it (site_code). Matching is exact, so the custom field key must be written in lowercase with underscores, as shown in Nautobot; variants such as SITE_CODE or site code are not matched.

To exclude Infoblox custom fields from being synchronized to Infoblox add the custom field names to the custom_fields list.

Custom Fields, Tags, and Relationships Used by The Infoblox Integration¶

The Infoblox Integration requires the following Nautobot custom fields, tags, and relationships to function correctly. These are created automatically when Nautobot is started and care should be taken to ensure these are not deleted.

Custom Fields¶

Custom Field key	Label (in UI)	Type	Applies to	Purpose
`ssot_synced_to_infoblox`	Last synced to Infoblox on	Date	`IPAddress`, `Prefix`, `VLAN`, `VLANGroup`	Date the object was last synchronized to Infoblox.
`dhcp_ranges`	DHCP Ranges	Text	`Prefix`	DHCP ranges associated with a network.
`mac_address`	MAC Address	Text	`IPAddress`	MAC address associated with an IP Address. Required to create an Infoblox Fixed Address of type MAC from a Nautobot IP Address.
`fixed_address_comment`	Fixed Address Comment	Text	`IPAddress`	Comment for the corresponding Fixed Address record in Infoblox.
`dns_a_record_comment`	DNS A Record Comment	Text	`IPAddress`	Comment for the corresponding DNS A record in Infoblox.
`dns_host_record_comment`	DNS Host Record Comment	Text	`IPAddress`	Comment for the corresponding DNS Host record in Infoblox.
`dns_ptr_record_comment`	DNS PTR Record Comment	Text	`IPAddress`	Comment for the corresponding DNS PTR record in Infoblox.

Tags¶

Tag	Applies to	Purpose
`SSoT Synced from Infoblox`	`IPAddress`, `Namespace`, `Prefix`, `VLAN`	Tags Nautobot objects that were synchronized from Infoblox.
`SSoT Synced to Infoblox`	`IPAddress`, `Prefix`, `VLAN`	Tags Nautobot objects that were synchronized to Infoblox.

Relationships¶

Relationship key	Label	Links	Purpose
`prefix_to_vlan`	Prefix -> VLAN	`Prefix` → `VLAN`	Links a Nautobot Prefix to a Nautobot VLAN. Corresponds to an Infoblox Network to VLAN relationship.

Usage Notes¶

To create an Infoblox Fixed Address record from a Nautobot IP Address object the Nautobot side must have IP Address type set to DHCP.
To create an Infoblox Fixed Address of type MAC the Nautobot IP Address must have a value defined in the mac_address custom field.

Upgrading from `nautobot-plugin-ssot-infoblox` App¶