mirror of
https://github.com/netbox-community/netbox.git
synced 2025-09-08 07:09:30 -06:00
063d1fef7a
* Closes #18797: Support path import for certain Jinja environment parameters * Document dotted path support for Jinja env params
52 lines
1.9 KiB
Markdown
52 lines
1.9 KiB
Markdown
# Export Templates
|
|
|
|
Export templates are used to render arbitrary data from a set of NetBox objects. For example, you might want to automatically generate a network monitoring service configuration from a list of device objects. See the [export templates documentation](../../customization/export-templates.md) for more information.
|
|
|
|
## Fields
|
|
|
|
### Name
|
|
|
|
The name of the export template. This will appear in the "export" dropdown list in the NetBox UI.
|
|
|
|
### Content Type
|
|
|
|
The type of NetBox object to which the export template applies.
|
|
|
|
### 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 local content for the template: It will be populated automatically from the data file.
|
|
|
|
### Template Code
|
|
|
|
Jinja2 template code for rendering the exported data.
|
|
|
|
### Environment Parameters
|
|
|
|
!!! info "This field was introduced in NetBox v4.3."
|
|
|
|
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 export 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).
|