Configuration Templates

Configuration templates can be used to render device configurations from context data. Templates are written in the Jinja2 language and can be associated with devices roles, platforms, and/or individual devices.

Context data is made available to devices and/or virtual machines based on their relationships to other objects in NetBox. For example, context data can be associated only with devices assigned to a particular site, or only to virtual machines in a certain cluster.

See the configuration rendering documentation for more information.

Fields

Name

A unique human-friendly name.

Data File

Template code may optionally be sourced from a remote data file, which is synchronized from a remote data source. When designating a data file, there is no need to specify template code: It will be populated automatically from the data file.

Template Code

Jinja2 template code, if being defined locally rather than replicated from a data file.

Environment Parameters

A dictionary of any additional parameters to pass when instantiating the Jinja2 environment. Jinja2 supports various optional parameters which can be used to modify its default behavior.

MIME Type

This field was introduced in NetBox v4.3.

The MIME type to indicate in the response when rendering the configuration template (optional). Defaults to text/plain.

File Name

This field was introduced in NetBox v4.3.

The file name to give to the rendered export file (optional).

File Extension

This field was introduced in NetBox v4.3.

The file extension to append to the file name in the response (optional).

As Attachment

This field was introduced in NetBox v4.3.

If selected, the rendered content will be returned as a file attachment, rather than displayed directly in-browser (where supported).