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

Allow to store configuration of a device #6634

New Issue
Closed
opened 2025-12-29 19:43:21 +01:00 by adam · 1 comment
adam commented 2025-12-29 19:43:21 +01:00
Owner
Copy Link

Originally created by @abhi1693 on GitHub (Jul 7, 2022).

NetBox version

v3.2.5

Feature type

Change to existing functionality

Proposed functionality

As of today, NetBox uses Napalm to fetch the configuration from the device, however, for this to work NetBox should have direct access to the devices and the exact same credentials on all the devices as well.

I'm proposing to leave the current implementation as is since there are installations (probably) that do use this functionality. However, enable database fields where this configuration can also be saved to view it in cases when NetBox cannot either reach the device or the data is either updated by hand, API or scripts.

This gives us the ability to view the configuration at the very least and know when it was last updated on the NetBox.

In my organization, we have 95% of NetBox running via automation, this is one piece that we are unable to utilize.

image
image

Since the above failed to connect, I do not have any way via NetBox to view my configuration.

It also does not make sense that I should add access to all my network devices just so that NetBox should be able to query then and have the exact same credentials on all of them either.

Use case

In our environment, NetBox does not have access to any device that exists in our infrastructure (due to security policies), however, we have built scripts that update NetBox with anything that can be modelled.

Now, there are still aspects of the configuration that we are unable to model as of today and our engineers would still prefer to see the complete configuration of the device. This functionality exists but is limited to the use case I described above.

With this change, people can easily post the configuration to NetBox and make it available to the other users as well. This would at the very least enable a historic view of the configuration.

With the proposed change, it solves another issue when the device is unavailable for any reason, an engineer can view the last changes that were stored on NetBox to help them gain visibility into what may have gone wrong.

Database changes

Add 3 new fields to the device model. It should allow storing extremely long texts

  • config_running
  • config_startup
  • config_candidate

External dependencies

No response

Originally created by @abhi1693 on GitHub (Jul 7, 2022). ### NetBox version v3.2.5 ### Feature type Change to existing functionality ### Proposed functionality As of today, NetBox uses Napalm to fetch the configuration from the device, however, for this to work NetBox should have direct access to the devices and the exact same credentials on all the devices as well. I'm proposing to leave the current implementation as is since there are installations (probably) that do use this functionality. However, enable database fields where this configuration can also be saved to view it in cases when NetBox cannot either reach the device or the data is either updated by hand, API or scripts. This gives us the ability to view the configuration at the very least and know when it was last updated on the NetBox. In my organization, we have 95% of NetBox running via automation, this is one piece that we are unable to utilize. ![image](https://user-images.githubusercontent.com/5083532/177728710-556e3b87-5727-43ff-9ddf-c23c027f49bc.png) ![image](https://user-images.githubusercontent.com/5083532/177728727-e3bb38a9-9bd5-44ef-b2ed-a8341c6b260e.png) Since the above failed to connect, I do not have any way via NetBox to view my configuration. It also does not make sense that I should add access to all my network devices just so that NetBox should be able to query then and have the exact same credentials on all of them either. ### Use case In our environment, NetBox does not have access to any device that exists in our infrastructure (due to security policies), however, we have built scripts that update NetBox with anything that can be modelled. Now, there are still aspects of the configuration that we are unable to model as of today and our engineers would still prefer to see the complete configuration of the device. This functionality exists but is limited to the use case I described above. With this change, people can easily post the configuration to NetBox and make it available to the other users as well. This would at the very least enable a historic view of the configuration. With the proposed change, it solves another issue when the device is unavailable for any reason, an engineer can view the last changes that were stored on NetBox to help them gain visibility into what may have gone wrong. ### Database changes Add 3 new fields to the device model. It should allow storing extremely long texts - config_running - config_startup - config_candidate ### External dependencies _No response_
adam added the plugin candidate label 2025-12-29 19:43:21 +01:00
adam closed this issue 2025-12-29 19:43:21 +01:00
adam commented 2025-12-29 19:43:22 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jul 7, 2022):

I'm afraid this sort of function is out of scope for NetBox, however there are multiple other tools available that do this. If you'd prefer to implement this functionality directly within NetBox, consider authoring a plugin.

@jeremystretch commented on GitHub (Jul 7, 2022): I'm afraid this sort of function is out of scope for NetBox, however there are multiple other tools available that do this. If you'd prefer to implement this functionality directly within NetBox, consider authoring a [plugin](https://docs.netbox.dev/en/stable/plugins/development/).
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 plugin candidate
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#6634
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?