Skip to content

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 2.0.0 and higher.
  • Databases supported: PostgreSQL, MySQL

Note

Please check the dedicated page for a full compatibility matrix and the deprecation policy.

Access Requirements

This plugin can be run with no additional access requirements, however there are extended services such as CVSS / NIST integration which depends on integration to the NIST public api service. Other examples would include access to the Cisco EoX api service which can be used to enrich data based on devices under contract coverage. Please leverage the documentation pages for the specific plugin integrations for details.

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-device-lifecycle-mgmt.

The plugin is available as a Python package via PyPI and can be installed with pip:

pip install nautobot-device-lifecycle-mgmt

To ensure Device Lifecycle Management 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-device-lifecycle-mgmt package:

echo nautobot-device-lifecycle-mgmt >> local_requirements.txt

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_device_lifecycle_mgmt" to the PLUGINS list.
  • Append the "nautobot_device_lifecycle_mgmt" dictionary to the PLUGINS_CONFIG dictionary and override any defaults.
# In your nautobot_config.py
PLUGINS = ["nautobot_device_lifecycle_mgmt"]

# Optionally you can override default settings for config items in the device lifecylce plugin (as seen in this example)
PLUGINS_CONFIG = {
    "nautobot_device_lifecycle_mgmt": {
        "barchart_bar_width": float(os.environ.get("BARCHART_BAR_WIDTH", 0.1)),
        "barchart_width": int(os.environ.get("BARCHART_WIDTH", 12)),
        "barchart_height": int(os.environ.get("BARCHART_HEIGHT", 5)),
    },
}

Once the Nautobot configuration is updated, run the Post Upgrade command (nautobot-server post_upgrade) to run migrations and clear any cache:

nautobot-server post_upgrade

Then restart (if necessary) the Nautobot services which may include:

  • Nautobot
  • Nautobot Workers
  • Nautobot Scheduler
sudo systemctl restart nautobot nautobot-worker nautobot-scheduler

App Configuration

The plugin behavior can be controlled with the following list of settings: | Key | Example | Default | Description | | -------------------- | ------------------------- | ------- | -------------------------------------------------------------------- | | expired_field | end_of_support | | The field name representing the expiry date. | | barchart_bar_width | 0.1 | 0.15 | The width of the table bar within the overview report. | | barchart_width | 12 | | The width of the barchart within the overview report. | | barchart_height | 5 | | The height of the barchart within the overview report. |