/netbox-zero-to-hero

A short course designed to take new NetBox users from ‘Zero to Hero’.

Primary LanguagePython

NetBox - Zero To Hero Course

Introduction

Hello and welcome to this short course designed to take new NetBox users from 'Zero to Hero'. We are excited to have you here!

The goals of this course are as follows:

  • Enable you to get up and running with minimal fuss and immediately start to get value from NetBox
  • Build a solid foundation from which you can start to leverage NetBox's extra features ie. custom fields, reports, plugins etc
  • Introduce the power of NetBox to drive your Network Automation efforts as the 'Single Source Of Truth' for your NetDevOps workflows

Course Format

The course consists of bite sized modules, each one introducing a new concept or feature of NetBox. Each module is a step in the journey that leads to the deployment of a new branch office network at a remote site for a fictional company.

Each module includes a video teaching you how to interact with NetBox either via the Web UI or programmatically using the REST API. You can follow along with your own instance of NetBox, and all the code is available in the accompanying Git Repository - including a Postman Collection, Ansible Playbooks and Python Scripts - so you will have a fully working code base which you can clone to get you started on your way to becoming a NetBox Hero!

Join the Discussion

If you have any questions as you go through the course then pop on over to the NetBox Zero to Hero channel on the NetDev Community Slack! If you aren't already a member then you can sign up for free here.

Example Scenario

The fictional scenario that will be used throughout this course to demonstrate NetBox features is:

  • The organization is a small consulting firm, with a small IT team
  • The network consists of two Data Centers, plus multiple branch office locations around the world
  • Susan and Eric are awesome Network Engineers with a burning desire to introduce this amazing 'NetDevOps' stuff they keep hearing about (so they can do less work but still wow the bosses!)
  • The network team has been handed a new project to deploy a branch office network in the new location in Brisbane, Australia. The corporate standard branch office design consists of a WAN Router, an Access Switch and Wireless Access Points
  • Susan and Eric are going to use NetBox every step of the way to help deliver the project on time and also to power some network automation to get the devices configured error free (this has long been a problem for them with new sites taking hours and even days to stand up!)

So, with that said, lets dive in!

Modules

Module 1: Introduction

  • NetBox overview
  • Introduction to the Web Interface and the REST API

Module 2: Setting up the Organization

  • Model the organization using tenant groups, tenants, regions, site groups, sites, locations, racks and contacts
  • Use the web interface to manually add data for the organization
  • Use the web interface to bulk upload data for the organization

Module 3: Adding the Kit

  • Add Manufacturers, Device Types, Platforms, Device Roles and Devices
  • Use Postman to make REST API calls into NetBox to add devices

Module 4: IP Addressing and VLANs

  • Add IPAM (IP Address Management) Data - RIRs, Aggregates, Prefixes, IP Addresses and VLANs
  • Integrate NetBox with Ansible, and run playbooks to populate the NetBox database with IPAM data

Module 5: Making the Connections

  • Add the Cables, Interface, console and power connections
  • Use the web interface to bulk upload data for Cables and Connections
  • Use the web interface to view the Cables, Interface and Console connections

Module 6: Setting up the WiFi

  • Add Wireless LANs
  • Use simple Python scripts to interact with the NetBox REST API to add Wireless LANs
  • Use the web interface to view Wireless LAN information

Module 7: Automate All the Things!

  • Set up Ansible to use NetBox as the source of it's Dynamic Inventory
  • Write Ansible playbooks to make REST API calls to NetBox and extract the data to build the device configurations
  • Automate the generation of device configurations using Jinja templates, passing in the data from NetBox

Module 8: What About Virtualization?

  • Describe how NetBox models Virtualization, including Cluster Types, Clusters, Platforms, VMs and VM Interfaces
  • Describe how to model network services associated with devices and/or virtual machines, along with specific IP addresses
  • Use the web interface to manually add Virtualization and service data, including bulk uploading larger amounts of data where required

Module 9: Powering Up!

  • Describe how NetBox models facility power as discrete power panels and feeds
  • Understand how to add Power Distribution Units (PDUs) to supply power to individual devices
  • Use the web interface to manually add all data relating to facility power including bulk uploading cable connections from CSV data

Module 10: Providers and Circuits

  • Describe how NetBox models service providers and circuits
  • Understand how to "connect" circuits directly to device interfaces via cables
  • Use Postman to make API calls to NetBox to add this data programmatically

Module 11: Custom Scripts

  • Describe what Custom Scripts are in NetBox and what kind of tasks they can be used to accomplish
  • Understand the basics of writing Custom Scripts and also where to find documentation to help you develop your own scripts
  • Kick start your own Custom Scripts collection, with two example scripts to get you up and running.

Module 12: The Boss is Asking for a Report (another easy win!)

  • Describe what NetBox reports are and what kind of things they can be used to verify
  • Understand the basics of reports and also where to find documentation and examples to help you develop your own reports
  • Kick start your own NetBox reports collection, with two example reports to get you up and running

Useful Links