starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Add do extension to Jinja2 for Config Rendering #7954

New Issue
Closed
opened 2025-12-29 20:30:27 +01:00 by adam · 2 comments
adam commented 2025-12-29 20:30:27 +01:00
Owner
Copy Link

Originally created by @peterbaumert on GitHub (Apr 28, 2023).

NetBox version

v3.5.0

Feature type

New functionality

Proposed functionality

It would be great if the jinja2 do extension could be added, this would enable more flexibility in creating complex configuration templates.

Currently using do results in following error:

Traceback (most recent call last):
  File "/opt/netbox/netbox/dcim/views.py", line 2044, in get_extra_context
    rendered_config = config_template.render(context=context_data)
  File "/opt/netbox/netbox/extras/models/configs.py", line 252, in render
    output = template.render(**context)
  File "/opt/netbox/venv/lib/python3.9/site-packages/jinja2/environment.py", line 1301, in render
    self.environment.handle_exception()
  File "/opt/netbox/venv/lib/python3.9/site-packages/jinja2/environment.py", line 936, in handle_exception
    raise rewrite_traceback_stack(source=source)
  File "switches/roles/access-switch.j2", line 1, in top-level template code
  File "switches/base.j2", line 2, in top-level template code
  File "switches/roles/access-switch.j2", line 5, in block 'content'
  File "/opt/netbox/netbox/utilities/jinja2.py", line 28, in get_source
    if referenced_templates := find_referenced_templates(environment.parse(template_source)):
  File "/opt/netbox/venv/lib/python3.9/site-packages/jinja2/environment.py", line 936, in handle_exception
    raise rewrite_traceback_stack(source=source)
  File "<unknown>", line 8, in template
jinja2.exceptions.TemplateSyntaxError: Encountered unknown tag 'do'. Jinja was looking for the following tags: 'elif' or 'else' or 'endif'. The innermost block that needs to be closed is 'if'.

Use case

Writing more complex configuration templates.

Database changes

None

External dependencies

jinja2 do extension

Originally created by @peterbaumert on GitHub (Apr 28, 2023). ### NetBox version v3.5.0 ### Feature type New functionality ### Proposed functionality It would be great if the jinja2 do extension could be added, this would enable more flexibility in creating complex configuration templates. Currently using do results in following error: ``` Traceback (most recent call last): File "/opt/netbox/netbox/dcim/views.py", line 2044, in get_extra_context rendered_config = config_template.render(context=context_data) File "/opt/netbox/netbox/extras/models/configs.py", line 252, in render output = template.render(**context) File "/opt/netbox/venv/lib/python3.9/site-packages/jinja2/environment.py", line 1301, in render self.environment.handle_exception() File "/opt/netbox/venv/lib/python3.9/site-packages/jinja2/environment.py", line 936, in handle_exception raise rewrite_traceback_stack(source=source) File "switches/roles/access-switch.j2", line 1, in top-level template code File "switches/base.j2", line 2, in top-level template code File "switches/roles/access-switch.j2", line 5, in block 'content' File "/opt/netbox/netbox/utilities/jinja2.py", line 28, in get_source if referenced_templates := find_referenced_templates(environment.parse(template_source)): File "/opt/netbox/venv/lib/python3.9/site-packages/jinja2/environment.py", line 936, in handle_exception raise rewrite_traceback_stack(source=source) File "<unknown>", line 8, in template jinja2.exceptions.TemplateSyntaxError: Encountered unknown tag 'do'. Jinja was looking for the following tags: 'elif' or 'else' or 'endif'. The innermost block that needs to be closed is 'if'. ``` ### Use case Writing more complex configuration templates. ### Database changes None ### External dependencies [jinja2 do extension](https://jinja.palletsprojects.com/en/3.0.x/extensions/#expression-statement)
adam added the type: feature label 2025-12-29 20:30:27 +01:00
adam closed this issue 2025-12-29 20:30:28 +01:00
adam commented 2025-12-29 20:30:28 +01:00
Author
Owner
Copy Link

@kkthxbye-code commented on GitHub (Apr 28, 2023):

You can add environment parameters to the Config Template in the Environment params field.

{"extensions": ["jinja2.ext.do"]}

The above seems to work. As such, I don't think there's anything to do here. I'll close this, if I misunderstood or it doesn't work for you, let me know.

@kkthxbye-code commented on GitHub (Apr 28, 2023): You can add environment parameters to the Config Template in the `Environment params` field. `{"extensions": ["jinja2.ext.do"]}` The above seems to work. As such, I don't think there's anything to do here. I'll close this, if I misunderstood or it doesn't work for you, let me know.
adam commented 2025-12-29 20:30:28 +01:00
Author
Owner
Copy Link

@peterbaumert commented on GitHub (Apr 28, 2023):

oh thank you, didn't find this in documentation

@peterbaumert commented on GitHub (Apr 28, 2023): oh thank you, didn't find this in documentation
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label type: feature
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#7954
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?