Installing the App in Nautobot¶
Here you will find detailed instructions on how to install and configure the App within your Nautobot environment.
Prerequisites¶
- The plugin is compatible with Nautobot 1.6.0 and higher.
- Databases supported: PostgreSQL, MySQL
Note
Please check the dedicated page for a full compatibility matrix and the deprecation policy.
Access Requirements¶
The plugin does not directly communicate with NetBox, data is imported by first running a Django data dump command from the CLI of the NetBox server then providing the JSON export to a management command on the Nautobot server. Detailed instructions are located on the Using the App page.
Install Guide¶
Note
Plugins can be installed manually or using Python's pip
. See the Nautobot documentation for more details. The pip package name for this plugin is nautobot-netbox-importer
.
The plugin is available as a Python package via PyPI and can be installed with pip
:
To ensure Nautobot NetBox Importer is automatically re-installed during future upgrades, create a file named local_requirements.txt
(if not already existing) in the Nautobot root directory (alongside requirements.txt
) and list the nautobot-netbox-importer
package:
Once installed, the plugin needs to be enabled in your Nautobot configuration. The following block of code below shows the additional configuration required to be added to your nautobot_config.py
file:
- Append
"nautobot_netbox_importer"
to thePLUGINS
list. - Append the
"nautobot_netbox_importer"
dictionary to thePLUGINS_CONFIG
dictionary and override any defaults.
Once the Nautobot configuration is updated, run the Post Upgrade command (nautobot-server post_upgrade
) to run migrations and clear any cache:
Then restart (if necessary) the Nautobot services which may include:
- Nautobot
- Nautobot Workers
- Nautobot Scheduler
App Configuration¶
There is no specific configuration required for the App to work.