Skip to content

Modules

Module Types

A module type represent a specific make and model of hardware component which is installable within a device and has its own child components. For example, consider a chassis-based switch or router with a number of field-replaceable line cards. Each line card has its own model number and includes a certain set of components such as interfaces. Each module type may have a manufacturer, model number, and part number assigned to it.

Similar to device types, each module type can have any of the following component templates associated with it:

  • Interfaces

  • Console ports

  • Console server ports

  • Power ports

  • Power Outlets

  • Front pass-through ports

  • Rear pass-through ports

Note that device bays and module bays may not be added to modules.

Automatic Component Renaming

When adding component templates to a module type, the string {module} can be used to reference the position field of the module bay into which an instance of the module type is being installed.

For example, you can create a module type with interface templates named Gi{module}/0/[1-48]. When a new module of this type is "installed" to a module bay with a position of "3", NetBox will automatically name these interfaces Gi3/0/[1-48].

Automatic renaming is supported for all modular component types (those listed above).

Modules

A module is a field-replaceable hardware component installed within a device which houses its own child components. The most common example is a chassis-based router or switch.

Similar to devices, modules are instantiated from module types, and any components associated with the module type are automatically instantiated on the new model. Each module must be installed within a module bay on a device, and each module bay may have only one module installed in it. A module may optionally be assigned a serial number and asset tag.