netbox vlan assignment

Front Ports

Module bays, device bays, inventory items, virtual chassis.

• Device Types
• Virtualization
• Service Mapping
• Power Tracking
• Permissions
• Error Reporting
• Housekeeping
• Replicating NetBox
• NetBox Shell

Devices and Cabling

Every piece of hardware which is installed within a site or rack exists in NetBox as a device. Devices are measured in rack units (U) and can be half depth or full depth. A device may have a height of 0U: These devices do not consume vertical rack space and cannot be assigned to a particular rack unit. A common example of a 0U device is a vertically-mounted PDU.

When assigning a multi-U device to a rack, it is considered to be mounted in the lowest-numbered rack unit which it occupies. For example, a 3U device which occupies U8 through U10 is said to be mounted in U8. This logic applies to racks with both ascending and descending unit numbering.

A device is said to be full-depth if its installation on one rack face prevents the installation of any other device on the opposite face within the same rack unit(s). This could be either because the device is physically too deep to allow a device behind it, or because the installation of an opposing device would impede airflow.

Each device must be instantiated from a pre-created device type, and its default components (console ports, power ports, interfaces, etc.) will be created automatically. (The device type associated with a device may be changed after its creation, however its components will not be updated retroactively.)

Each device must be assigned a site, device role, and operational status, and may optionally be assigned to a specific location and/or rack within a site. A platform, serial number, and asset tag may optionally be assigned to each device.

Device names must be unique within a site, unless the device has been assigned to a tenant. Devices may also be unnamed.

When a device has one or more interfaces with IP addresses assigned, a primary IP for the device can be designated, for both IPv4 and IPv6.

Device Roles

Devices can be organized by functional roles, which are fully customizable by the user. For example, you might create roles for core switches, distribution switches, and access switches within your network.

A platform defines the type of software running on a device or virtual machine. This can be helpful to model when it is necessary to distinguish between different versions or feature sets. Note that two devices of the same type may be assigned different platforms: For example, one Juniper MX240 might run Junos 14 while another runs Junos 15.

Platforms may optionally be limited by manufacturer: If a platform is assigned to a particular manufacturer, it can only be assigned to devices with a type belonging to that manufacturer.

The platform model is also used to indicate which NAPALM driver (if any) and any associated arguments NetBox should use when connecting to a remote device. The name of the driver along with optional parameters are stored with the platform.

The assignment of platforms to devices is an optional feature, and may be disregarded if not desired.

Device Components

Device components represent discrete objects within a device which are used to terminate cables, house child devices, or track resources.

Console Ports

A console port provides connectivity to the physical console of a device. These are typically used for temporary access by someone who is physically near the device, or for remote out-of-band access provided via a networked console server. Each console port may be assigned a physical type.

Cables can connect console ports to console server ports or pass-through ports.

Console Server Ports

A console server is a device which provides remote access to the local consoles of connected devices. They are typically used to provide remote out-of-band access to network devices. Each console server port may be assigned a physical type.

Cables can connect console server ports to console ports or pass-through ports.

Power Ports

A power port represents the inlet of a device where it draws its power, i.e. the connection port(s) on a device's power supply. Each power port may be assigned a physical type, as well as allocated and maximum draw values (in watts). These values can be used to calculate the overall utilization of an upstream power feed.

When creating a power port on a device which supplies power to downstream devices, the allocated and maximum draw numbers should be left blank. Utilization will be calculated by taking the sum of all power ports of devices connected downstream.

Cables can connect power ports only to power outlets or power feeds. (Pass-through ports cannot be used to model power distribution.)

Power Outlets

Power outlets represent the outlets on a power distribution unit (PDU) or other device that supply power to dependent devices. Each power port may be assigned a physical type, and may be associated with a specific feed leg (where three-phase power is used) and/or a specific upstream power port. This association can be used to model the distribution of power within a device.

For example, imagine a PDU with one power port which draws from a three-phase feed and 48 power outlets arranged into three banks of 16 outlets each. Outlets 1-16 would be associated with leg A on the port, and outlets 17-32 and 33-48 would be associated with legs B and C, respectively.

Cables can connect power outlets only to downstream power ports. (Pass-through ports cannot be used to model power distribution.)

Interfaces in NetBox represent network interfaces used to exchange data with connected devices. On modern networks, these are most commonly Ethernet, but other types are supported as well. Each interface must be assigned a type, and may optionally be assigned a MAC address, MTU, and IEEE 802.1Q mode (tagged or access). Each interface can also be enabled or disabled, and optionally designated as management-only (for out-of-band management). Additionally, each interface may optionally be assigned to a VRF.

Although devices and virtual machines both can have interfaces, a separate model is used for each. Thus, device interfaces have some properties that are not present on virtual machine interfaces and vice versa.

Interface Types

Interfaces may be physical or virtual in nature, but only physical interfaces may be connected via cables. Cables can connect interfaces to pass-through ports, circuit terminations, or other interfaces. Virtual interfaces, such as 802.1Q-tagged subinterfaces, may be assigned to physical parent interfaces.

Physical interfaces may be arranged into a link aggregation group (LAG) and associated with a parent LAG (virtual) interface. LAG interfaces can be recursively nested to model bonding of trunk groups. Like all virtual interfaces, LAG interfaces cannot be connected physically.

Wireless Interfaces

Wireless interfaces may additionally track the following attributes:

Role - AP or station

Channel - One of several standard wireless channels

Channel Frequency - The transmit frequency

Channel Width - Channel bandwidth

If a predefined channel is selected, the frequency and width attributes will be assigned automatically. If no channel is selected, these attributes may be defined manually.

IP Address Assignment

IP addresses can be assigned to interfaces. VLANs can also be assigned to each interface as either tagged or untagged. (An interface may have only one untagged VLAN.)

Front ports are pass-through ports used to represent physical cable connections that comprise part of a longer path. For example, the ports on the front face of a UTP patch panel would be modeled in NetBox as front ports. Each port is assigned a physical type, and must be mapped to a specific rear port on the same device. A single rear port may be mapped to multiple front ports, using numeric positions to annotate the specific alignment of each.

Like front ports, rear ports are pass-through ports which represent the continuation of a path from one cable to the next. Each rear port is defined with its physical type and a number of positions: Rear ports with more than one position can be mapped to multiple front ports. This can be useful for modeling instances where multiple paths share a common cable (for example, six discrete two-strand fiber connections sharing a 12-strand MPO cable).

Front and rear ports need not necessarily reside on the actual front or rear device face. This terminology is used primarily to distinguish between the two components in a pass-through port pairing.

Module bays represent a space or slot within a device in which a field-replaceable module may be installed. A common example is that of a chassis-based switch such as the Cisco Nexus 9000 or Juniper EX9200. Modules in turn hold additional components that become available to the parent device.

Device bays represent a space or slot within a parent device in which a child device may be installed. For example, a 2U parent chassis might house four individual blade servers. The chassis would appear in the rack elevation as a 2U device with four device bays, and each server within it would be defined as a 0U device installed in one of the device bays. Child devices do not appear within rack elevations or count as consuming rack units.

Child devices are first-class Devices in their own right: That is, they are fully independent managed entities which don't share any control plane with the parent. Just like normal devices, child devices have their own platform (OS), role, tags, and components. LAG interfaces may not group interfaces belonging to different child devices.

Device bays are not suitable for modeling line cards (such as those commonly found in chassis-based routers and switches), as these components depend on the control plane of the parent device to operate. Instead, these should be modeled as modules installed within module bays.

Inventory items represent hardware components installed within a device, such as a power supply or CPU or line card. They are intended to be used primarily for inventory purposes.

Each inventory item can be assigned a functional role, manufacturer, part ID, serial number, and asset tag (all optional). A boolean toggle is also provided to indicate whether each item was entered manually or discovered automatically (by some process outside NetBox).

Inventory items are hierarchical in nature, such that any individual item may be designated as the parent for other items. For example, an inventory item might be created to represent a line card which houses several SFP optics, each of which exists as a child item within the device. An inventory item may also be associated with a specific component within the same device. For example, you may wish to associate a transceiver with an interface.

A virtual chassis represents a set of devices which share a common control plane. A common example of this is a stack of switches which are connected and configured to operate as a single device. A virtual chassis must be assigned a name and may be assigned a domain.

Each device in the virtual chassis is referred to as a VC member, and assigned a position and (optionally) a priority. VC member devices commonly reside within the same rack, though this is not a requirement. One of the devices may be designated as the VC master: This device will typically be assigned a name, services, virtual interfaces, and other attributes related to managing the VC.

If a VC master is defined, interfaces from all VC members are displayed when navigating to its device interfaces view. This does not include other members interfaces declared as management-only.

It's important to recognize the distinction between a virtual chassis and a chassis-based device. A virtual chassis is not suitable for modeling a chassis-based switch with removable line cards (such as the Juniper EX9208), as its line cards are not physically autonomous devices.

All connections between device components in NetBox are represented using cables. A cable represents a direct physical connection between two termination points, such as between a console port and a patch panel port, or between two network interfaces.

Each cable must have two endpoints defined. These endpoints are sometimes referenced as A and B for clarity, however cables are direction-agnostic and the order in which terminations are made has no meaning. Cables may be connected to the following objects:

Circuit terminations

Console ports

Console server ports

Pass-through ports (front and rear)

Power feeds

Power outlets

Power ports

Each cable may be assigned a type, label, length, and color. Each cable is also assigned one of three operational statuses:

Active (default)

Decommissioning

Tracing Cables

A cable may be traced from either of its endpoints by clicking the "trace" button. (A REST API endpoint also provides this functionality.) NetBox will follow the path of connected cables from this termination across the directly connected cable to the far-end termination. If the cable connects to a pass-through port, and the peer port has another cable connected, NetBox will continue following the cable path until it encounters a non-pass-through or unconnected termination point. The entire path will be displayed to the user.

In the example below, three individual cables comprise a path between devices A and D:

Traced from Interface 1 on Device A, NetBox will show the following path:

• Cable 1: Interface 1 to Front Port 1
• Cable 2: Rear Port 1 to Rear Port 2
• Cable 3: Front Port 2 to Interface 2

• Sites and Racks
• Devices and Cabling
• Device Types
• Virtualization
• Service Mapping
• Power Tracking

VLAN Management

A VLAN represents an isolated layer two domain, identified by a name and a numeric ID (1-4094) as defined in IEEE 802.1Q . VLANs are arranged into VLAN groups to define scope and to enforce uniqueness.

Each VLAN must be assigned one of the following operational statuses:

As with prefixes, each VLAN may also be assigned a functional role. Prefixes and VLANs share the same set of customizable roles.

VLAN Groups

VLAN groups can be used to organize VLANs within NetBox. Each VLAN group can be scoped to a particular region, site group, site, location, rack, cluster group, or cluster. Member VLANs will be available for assignment to devices and/or virtual machines within the specified scope.

Groups can also be used to enforce uniqueness: Each VLAN within a group must have a unique ID and name. VLANs which are not assigned to a group may have overlapping names and IDs (including VLANs which belong to a common site). For example, you can create two VLANs with ID 123, but they cannot both be assigned to the same group.

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!

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!

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

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 .

Useful Links

• Community Reports Git repo
• Zero To Hero Git Repo
• Official NetBox Documentation
• NetBox GitHub
• NetBox Docker
• GitHub Discussions
• NetBox Community Device Type Library
• NetBox Cloud  is a hosted solution offered by NetBox Labs

• AnsibleFest
• Webinars & Training

• Collection Index
• Collections in the Netbox Namespace
• Netbox.Netbox

Netbox.Netbox 

Collection version 3.17.0

Description 

This is a collection of NetBox Ansible modules

Mikhail Yohman < mikhail . yohman @ gmail . com >

Martin Rødvand < martin @ rodvand . net >

Supported ansible-core versions:

2.9.10 or newer

• Issue Tracker
• Repository (Sources)

Plugin Index 

These are the plugins in the netbox.netbox collection:

netbox_aggregate module – Creates or removes aggregates from NetBox

netbox_asn module – Create, update or delete ASNs within NetBox

netbox_cable module – Create, update or delete cables within NetBox

netbox_circuit module – Create, update or delete circuits within NetBox

netbox_circuit_termination module – Create, update or delete circuit terminations within NetBox

netbox_circuit_type module – Create, update or delete circuit types within NetBox

netbox_cluster module – Create, update or delete clusters within NetBox

netbox_cluster_group module – Create, update or delete cluster groups within NetBox

netbox_cluster_type module – Create, update or delete cluster types within NetBox

netbox_config_context module – Creates, updates or deletes configuration contexts within NetBox

netbox_config_template module – Creates or removes config templates from NetBox

netbox_console_port module – Create, update or delete console ports within NetBox

netbox_console_port_template module – Create, update or delete console port templates within NetBox

netbox_console_server_port module – Create, update or delete console server ports within NetBox

netbox_console_server_port_template module – Create, update or delete console server port templates within NetBox

netbox_contact module – Creates or removes contacts from NetBox

netbox_contact_group module – Creates or removes contact groups from NetBox

netbox_contact_role module – Creates or removes contact roles from NetBox

netbox_custom_field module – Creates, updates or deletes custom fields within NetBox

netbox_custom_link module – Creates, updates or deletes custom links within NetBox

netbox_device module – Create, update or delete devices within NetBox

netbox_device_bay module – Create, update or delete device bays within NetBox

netbox_device_bay_template module – Create, update or delete device bay templates within NetBox

netbox_device_interface module – Creates or removes interfaces on devices from NetBox

netbox_device_interface_template module – Creates or removes interfaces on devices from NetBox

netbox_device_role module – Create, update or delete devices roles within NetBox

netbox_device_type module – Create, update or delete device types within NetBox

netbox_export_template module – Creates, updates or deletes export templates within NetBox

netbox_fhrp_group module – Create, update or delete FHRP groups within NetBox

netbox_fhrp_group_assignment module – Create, update or delete FHRP group assignments within NetBox

netbox_front_port module – Create, update or delete front ports within NetBox

netbox_front_port_template module – Create, update or delete front port templates within NetBox

netbox_inventory_item module – Creates or removes inventory items from NetBox

netbox_inventory_item_role module – Create, update or delete devices roles within NetBox

netbox_ip_address module – Creates or removes IP addresses from NetBox

netbox_ipam_role module – Creates or removes ipam roles from NetBox

netbox_journal_entry module – Creates a journal entry

netbox_l2vpn module – Create, update or delete L2VPNs within NetBox

netbox_l2vpn_termination module – Create, update or delete L2VPNs terminations within NetBox

netbox_location module – Create, update or delete locations within NetBox

netbox_manufacturer module – Create or delete manufacturers within NetBox

netbox_module_type module – Create, update or delete module types within NetBox

netbox_platform module – Create or delete platforms within NetBox

netbox_power_feed module – Create, update or delete power feeds within NetBox

netbox_power_outlet module – Create, update or delete power outlets within NetBox

netbox_power_outlet_template module – Create, update or delete power outlet templates within NetBox

netbox_power_panel module – Create, update or delete power panels within NetBox

netbox_power_port module – Create, update or delete power ports within NetBox

netbox_power_port_template module – Create, update or delete power port templates within NetBox

netbox_prefix module – Creates or removes prefixes from NetBox

netbox_provider module – Create, update or delete providers within NetBox

netbox_provider_network module – Create, update or delete provider networks within NetBox

netbox_rack module – Create, update or delete racks within NetBox

netbox_rack_group module – Create, update or delete racks groups within NetBox

netbox_rack_role module – Create, update or delete racks roles within NetBox

netbox_rear_port module – Create, update or delete rear ports within NetBox

netbox_rear_port_template module – Create, update or delete rear port templates within NetBox

netbox_region module – Creates or removes regions from NetBox

netbox_rir module – Create, update or delete RIRs within NetBox

netbox_route_target module – Creates or removes route targets from NetBox

netbox_service module – Creates or removes service from NetBox

netbox_service_template module – Create, update or delete service templates within NetBox

netbox_site module – Creates or removes sites from NetBox

netbox_site_group module – Create, update, or delete site groups within NetBox

netbox_tag module – Creates or removes tags from NetBox

netbox_tenant module – Creates or removes tenants from NetBox

netbox_tenant_group module – Creates or removes tenant groups from NetBox

netbox_virtual_chassis module – Create, update or delete virtual chassis within NetBox

netbox_virtual_disk module – Creates or removes disks from virtual machines in NetBox

netbox_virtual_machine module – Create, update or delete virtual_machines within NetBox

netbox_vlan module – Create, update or delete vlans within NetBox

netbox_vlan_group module – Create, update or delete vlans groups within NetBox

netbox_vm_interface module – Creates or removes interfaces from virtual machines in NetBox

netbox_vrf module – Create, update or delete vrfs within NetBox

netbox_webhook module – Creates, updates or deletes webhook configuration within NetBox

netbox_wireless_lan module – Creates or removes Wireless LANs from NetBox

netbox_wireless_lan_group module – Creates or removes Wireless LAN Groups from NetBox

netbox_wireless_link module – Creates or removes Wireless links from NetBox

Inventory Plugins 

nb_inventory inventory – NetBox inventory source

Lookup Plugins 

nb_lookup lookup – Queries and returns elements from NetBox

List of collections with docs hosted here.

Search code, repositories, users, issues, pull requests...

Provide feedback.

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly.

To see all available qualifiers, see our documentation .

• Notifications

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement . We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Voice VLAN Assignment to Access Port #2215

DanSheps commented Jul 3, 2018

• 👍 1 reaction

larsuhartmann commented Jul 3, 2018

Sorry, something went wrong.

jeremystretch commented Jul 5, 2018

lampwins commented Jul 5, 2018 • edited

Dansheps commented jul 10, 2018 • edited.

No branches or pull requests