Device Templates: Description not carried over to device #8504

Closed
opened 2025-12-29 20:37:32 +01:00 by adam · 4 comments
Owner

Originally created by @bitcollector1 on GitHub (Aug 24, 2023).

NetBox version

v3.5.8

Python version

3.8

Steps to Reproduce

Create a Device Template and Add A description

Screenshot 2023-08-23 at 15 43 03

Expected Behavior

Descriptions from the template should be present on the device

Screenshot 2023-08-23 at 15 43 13

Observed Behavior

The Descriptions never made it to the final device. In this case the lanes are used to build my ZTP config, so this is pretty important info.

Also, the eth0 already existed on the device, so I don't think that description would have worked, like the rest of the interfaces shown.

Originally created by @bitcollector1 on GitHub (Aug 24, 2023). ### NetBox version v3.5.8 ### Python version 3.8 ### Steps to Reproduce Create a Device Template and Add A description ![Screenshot 2023-08-23 at 15 43 03](https://github.com/netbox-community/netbox/assets/50723251/bee40cb5-643b-413c-a072-1aebcdfbb86a) ### Expected Behavior Descriptions from the template should be present on the device ![Screenshot 2023-08-23 at 15 43 13](https://github.com/netbox-community/netbox/assets/50723251/5fe78011-c8e9-451e-b019-76f397da2fdd) ### Observed Behavior The Descriptions never made it to the final device. In this case the lanes are used to build my ZTP config, so this is pretty important info. Also, the eth0 already existed on the device, so I don't think that description would have worked, like the rest of the interfaces shown.
adam closed this issue 2025-12-29 20:37:32 +01:00
Author
Owner

@jeremystretch commented on GitHub (Aug 24, 2023):

This behavior is intentional. The description field on an interface template (which belongs to a device type) serves to convey any noteworthy details about the interface in general, whereas the the description of an actual device interface is relevant to that specific instance and will vary from one device to another. It would not make sense to replicate descriptions from the interface templates because it would result in unnecessary duplication of information.

@jeremystretch commented on GitHub (Aug 24, 2023): This behavior is intentional. The description field on an interface template (which belongs to a device type) serves to convey any noteworthy details about the interface in general, whereas the the description of an actual device interface is relevant to that specific instance and will vary from one device to another. It would not make sense to replicate descriptions from the interface templates because it would result in unnecessary duplication of information.
Author
Owner

@bitcollector1 commented on GitHub (Aug 24, 2023):

I can script this easy enough but you guys should remove the description from the template option then as it makes no since to include it as it serves no functionality.

@bitcollector1 commented on GitHub (Aug 24, 2023): I can script this easy enough but you guys should remove the description from the template option then as it makes no since to include it as it serves no functionality.
Author
Owner

@bitcollector1 commented on GitHub (Aug 24, 2023):

I guess it could serve some purpose, outside of my use case, but it just adds confusion IMHO.

@bitcollector1 commented on GitHub (Aug 24, 2023): I guess it could serve some purpose, outside of my use case, but it just adds confusion IMHO.
Author
Owner

@bitcollector1 commented on GitHub (Aug 28, 2023):

I went with custom fields on the interfaces for the SONiC lanes and it works better than the description, so thanks for nudging me into a better solution :)

@bitcollector1 commented on GitHub (Aug 28, 2023): I went with custom fields on the interfaces for the SONiC lanes and it works better than the description, so thanks for nudging me into a better solution :)
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#8504