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

Storing Secrets for NAPALM usage #3963

New Issue
Closed
opened 2025-12-29 18:32:19 +01:00 by adam · 2 comments
adam commented 2025-12-29 18:32:19 +01:00
Owner
Copy Link

Originally created by @jameskirsop on GitHub (Aug 10, 2020).

Change Type

[X ] Addition
[ ] Correction
[ ] Deprecation
[ ] Cleanup (formatting, typos, etc.)

Area

[ ] Installation instructions
[ ] Configuration parameters
[ ] Functionality/features
[ ] REST API
[ ] Administration/development
[X ] Other

Proposed Changes

I'm finding it hard to work out how to functionally use the changes implemented to resolve #2113. It seems that I can pass these headers to the API (eg. using Postman) but how does one configure the Netbox web interface to use these dynamic credentials? There doesn't seem to be any documentation to describe how this should be performed.

For more a concrete definition of the problem, as I understand the original issue, the discussion indicated a desire to be able to store secrets in Netbox, or in the Contextual Configuration Data and then use these to pass along to NAPALM. If #2113 was indeed resolved according to the issue's discussion, then the Status and LLDP Neighbours tabs should be sending device credentials (and other NAPALM options if specified) to the API using the X-NAPALM-* headers - but I can't find anything to describe how this would be configured in the Netbox interface.

I could be misunderstanding the original issue, or the PR's attempt to address it, so this may need to become a feature request rather than a documentation change.

Originally created by @jameskirsop on GitHub (Aug 10, 2020). <!-- NOTE: IF YOUR ISSUE DOES NOT FOLLOW THIS TEMPLATE, IT WILL BE CLOSED. Please indicate the nature of the change by placing an X in one of the boxes below. --> ### Change Type [X ] Addition [ ] Correction [ ] Deprecation [ ] Cleanup (formatting, typos, etc.) ### Area [ ] Installation instructions [ ] Configuration parameters [ ] Functionality/features [ ] REST API [ ] Administration/development [X ] Other <!-- Describe the proposed change(s). --> ### Proposed Changes I'm finding it hard to work out how to _functionally_ use the changes implemented to resolve #2113. It seems that I can pass these headers to the API (eg. using Postman) but how does one configure the Netbox web interface to use these dynamic credentials? There doesn't seem to be any documentation to describe how this should be performed. For more a concrete definition of the problem, as I understand the original issue, the discussion indicated [a desire to be able to store secrets](https://github.com/netbox-community/netbox/issues/2113#issuecomment-405950228) in Netbox, or [in the Contextual Configuration Data](https://github.com/netbox-community/netbox/issues/2113#issuecomment-493911067) and then use these to pass along to NAPALM. If #2113 was indeed resolved according to the issue's discussion, then the `Status` and `LLDP Neighbours` tabs should be sending device credentials (and other NAPALM options if specified) to the API using the `X-NAPALM-*` headers - but I can't find anything to describe how this would be configured in the Netbox interface. I could be misunderstanding the original issue, or the PR's attempt to address it, so this may need to become a feature request rather than a documentation change.
adam added the status: duplicate label 2025-12-29 18:32:19 +01:00
adam closed this issue 2025-12-29 18:32:19 +01:00
adam commented 2025-12-29 18:32:19 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Aug 10, 2020):

but how does one configure the Netbox web interface to use these dynamic credentials?

This is not currently supported by the UI. The assumption is that if you're passing unique credentials to each device, you're probably (hopefully) using the REST API endpoint directly.

If #2113 was indeed resolved according to the issue's discussion

No specific implementation was ever proposed in #2113, but the addition of support for passing NAPALM credentials seemed adequate given the use case cited. If you'd like to open a new feature request for it, you're certainly welcome to do, but bear in mind that you'll need to propose a specific functionality and workflow (which #2113 did not).

@jeremystretch commented on GitHub (Aug 10, 2020): > but how does one configure the Netbox web interface to use these dynamic credentials? This is not currently supported by the UI. The assumption is that if you're passing unique credentials to each device, you're probably (hopefully) using the REST API endpoint directly. > If #2113 was indeed resolved according to the issue's discussion No specific implementation was ever proposed in #2113, but the addition of support for passing NAPALM credentials seemed adequate given the use case cited. If you'd like to open a new feature request for it, you're certainly welcome to do, but bear in mind that you'll need to propose a specific functionality and workflow (which #2113 did not).
adam commented 2025-12-29 18:32:20 +01:00
Author
Owner
Copy Link

@DanSheps commented on GitHub (Aug 11, 2020):

Closing this as it is superseded by #4980

@DanSheps commented on GitHub (Aug 11, 2020): Closing this as it is superseded by #4980
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 status: duplicate
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#3963
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?