Nautobot Device Type Library

About this Library

This library is intended to be used for populating device types in Nautobot. It contains a set of device type definitions expressed in YAML and arranged by manufacturer. Each file represents a discrete physical device type (e.g. make and model). These definitions can be loaded into Nautobot instead of creating new device type definitions manually.

If you would like to contribute to this library, please read through our contributing guide before submitting content.

Device Type Definitions

Each definition must include at minimum the following fields:

• manufacturer: The name of the manufacturer which produces this device type.
  • Type: String
• model: The model number of the device type. This must be unique per manufacturer.
  • Type: String

🧪 Valid Example:

manufacturer: Cisco
model: C9200L-48P-4G

The following fields may optionally be declared:

• part_number: An alternative representation of the model number (e.g. a SKU). (Default: None)
  • Type: String

🧪 Example: part_number: C9200L-48P-4G

• u_height: The height of the device type in rack units. (Default: 1)
  • Type: number (minimum of 0, multiple of 1)

🧪 Example: u_height: 12

• is_full_depth: A boolean which indicates whether the device type consumes both the front and rear rack faces. (Default: true)
  • Type: Boolean

🧪 Example: is_full_depth: false

• front_image: Indicates that this device has a front elevation image within the elevation-images folder. (Default: None)
  • NOTE: The elevation images folder requires the same folder name as this device. The file name must also adhere to <model>.front.<extension>. The extension must be a valid image extension and the image file must be a valid image. Some examples are bmp, gif, jpeg, png, tiff.
  • Type: Boolean

🧪 Example: front_image: True

• rear_image: Indicates that this device has a rear elevation image within the elevation-images folder. (Default: None)
  • NOTE: The elevation images folder requires the same folder name as this device. The file name must also adhere to <model>.rear.<extension>. The extension must be a valid image extension and the image file must be a valid image. Some examples are bmp, gif, jpeg, png, tiff.
  • Type: Boolean

🧪 Example: rear_image: True

• subdevice_role: Indicates that this is a parent or child device. (Default: None)
  • Type: String
  • Options:
    • parent
    • child

🧪 Example: subdevice_role: parent

• comments: A string field which allows for comments to be added to the device. (Default: None)
  • Type: String

🧪 Example: comments: This is a comment that will appear on newly created Nautobot devices of this type

For further detail on these attributes and those listed below, please reference the schema definitions and the Component Definitions below.

Component Definitions

Valid component types are listed below. Each type of component must declare a list of the individual component templates to be added.

• console-ports
• console-server-ports
• power-ports
• power-outlets
• interfaces
• front-ports
• rear-ports
• device-bays

The available fields for each type of component are listed below.

Console Ports (Documentation)

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.

• name: Name
• label: Label (optional)
• description: Description (optional)
• type: ConsolePort type choice (optional)

Console Server Ports (Documentation)

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, and generally connect to console ports.

• name: Name
• label: Label (optional)
• description: Description (optional)
• type: ConsolePort type choice (optional)

Power Ports (Documentation)

A power port is a device component which draws power from some external source (e.g. an upstream power outlet), and generally represents a power supply internal to a device.

• name: Name
• label: Label (optional)
• description: Description (optional)
• type: PowerPort type choice (optional)
• maximum_draw: The port's maximum power draw, in watts (optional)
• allocated_draw: The port's allocated power draw, in watts (optional)

Power Outlets (Documentation)

Power outlets represent the outlets on a power distribution unit (PDU) or other device that supplies 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.

• name: Name
• label: Label (optional)
• description: Description (optional)
• type: PortOutlet type choice (optional)
• power_port: The name of the power port on the device which powers this outlet (optional)
• feed_leg: The phase (leg) of power to which this outlet is mapped; A, B, or C (optional)

Interfaces (Documentation)

Interfaces in Nautobot 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. IP addresses and VLANs can be assigned to interfaces.

• name: Name
• type: Interface type choice
• label: Label (optional)
• description: Description (optional)
• mgmt_only: A boolean which indicates whether this interface is used for management purposes only (default: false)

Front Ports (Documentation)

Front ports are pass-through ports which 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 Nautobot 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.

• name: Name
• type: Port type choice
• rear_port: The name of the rear port on this device to which the front port maps
• rear_port_position: The corresponding position on the mapped rear port (default: 1)
• label: Label (optional)
• description: Description (optional)

Rear Ports (Documentation)

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).

• name: Name
• type: Port type choice
• label: Label (optional)
• description: Description (optional)
• positions: The number of front ports that can map to this rear port (default: 1)

Device Bays (Documentation)

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.

• name: Name
• label: Label (optional)
• description: Description (optional)

Repository Forked from NetBox Community Device Type Library

This repository started as a fork of the NetBox Device Type Library.