Skip to content

Getting Started with the App

This document provides a step-by-step tutorial on how to get the App going and how to use it.

Install the App

To install the App, please follow the instructions detailed in the Installation Guide.

First steps with the App

Prerequisites

You will need:

  • a device reachable from the Nautobot instance
    • this can an IP or DNS name
  • the device's credentials
  • to create a location in Nautobot

The device must be reachable from the Nautobot and Nautobot worker instances (usually if one can reach it, the other can as well). You can test reachability directly with ssh. Since the plugin uses Napalm and Netmiko, they could also be used for a more accurate test.

Locations are the only other Nautobot prerequisite for the plugin to onboard a device.

Onboarding a Device

Navigate to the Device Onboarding Job: Jobs > Perform Device Onboarding.

What are the next steps?

You can check out the Use Cases section for more examples or try out the job inputs with at least the required fields.

job input

The Nautobot job will pass the job execution to the worker which will initiate an onboarding and will reach out to the device and attempt to onboard it.