Add ability to template device name #1347
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
New Behavior
The property
hostname_field
can now be templated, allowing definition of the device name to be more flexible.Contrast to Current Behavior
The property was not templated and was forced to be in
custom_fields
Discussion: Benefits and Drawbacks
This will allow the use of any property defined on a device to be used as a name, like a serial number for example.
The change was made to be backward compatible, although this has not been tested now. I do plan to make tests if this change is approved.
If required, this change could be gated behind a flag.
Changes to the Documentation
The docs will also be updated to specify the new behaviour of this property
Proposed Release Note Entry
The
hostname_field
can now reference any value from the device with templated jinjaDouble Check
devel
branch.