mirror of
https://github.com/netbox-community/netbox.git
synced 2025-09-07 22:59:30 -06:00
48 lines
2.1 KiB
Markdown
48 lines
2.1 KiB
Markdown
# Configuration Templates
|
|
|
|
Configuration templates can be used to render [device](../dcim/device.md) configurations from [context data](../../features/context-data.md). Templates are written in the [Jinja2 language](https://jinja.palletsprojects.com/) and can be associated with devices roles, platforms, and/or individual devices.
|
|
|
|
Context data is made available to [devices](../dcim/device.md) and/or [virtual machines](../virtualization/virtualmachine.md) 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](../../features/configuration-rendering.md) for more information.
|
|
|
|
## Fields
|
|
|
|
### Name
|
|
|
|
A unique human-friendly name.
|
|
|
|
### Data File
|
|
|
|
Template code may optionally be sourced from a remote [data file](../core/datafile.md), 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](https://jinja.palletsprojects.com/en/3.1.x/api/#jinja2.Environment). Jinja2 supports various optional parameters which can be used to modify its default behavior.
|
|
|
|
The `undefined` and `finalize` Jinja environment parameters, which must reference a Python class or function, can define a dotted path to the desired resource. For example:
|
|
|
|
```json
|
|
{
|
|
"undefined": "jinja2.StrictUndefined"
|
|
}
|
|
```
|
|
|
|
### MIME Type
|
|
|
|
The MIME type to indicate in the response when rendering the configuration template (optional). Defaults to `text/plain`.
|
|
|
|
### File Name
|
|
|
|
The file name to give to the rendered export file (optional).
|
|
|
|
### File Extension
|
|
|
|
The file extension to append to the file name in the response (optional).
|
|
|
|
### As Attachment
|
|
If selected, the rendered content will be returned as a file attachment, rather than displayed directly in-browser (where supported). |