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

Introduce a utility function for accessing plugin configuration parameters #7065

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

Originally created by @jeremystretch on GitHub (Oct 3, 2022).

Originally assigned to: @jeremystretch on GitHub.

NetBox version

v3.3.4

Feature type

New functionality

Proposed functionality

Introduce a simple utility function that plugin authors can use to reference specific plugin configuration parameters. Such a solution might look like this:

from extras.plugins import get_plugin_config

myvar = get_plugin_config('plugin_name', 'myvar')

Use case

This proposal was prompted by #10346, which seeks to better document the intended method for referencing plugin configuration parameters (which is currently achieved by referencing settings.PLUGINS_CONFIG). This approach is offered as a more convenient mechanism for plugin authors.

Database changes

No response

External dependencies

No response

Originally created by @jeremystretch on GitHub (Oct 3, 2022). Originally assigned to: @jeremystretch on GitHub. ### NetBox version v3.3.4 ### Feature type New functionality ### Proposed functionality Introduce a simple utility function that plugin authors can use to reference specific plugin configuration parameters. Such a solution might look like this: ```python from extras.plugins import get_plugin_config myvar = get_plugin_config('plugin_name', 'myvar') ``` ### Use case This proposal was prompted by #10346, which seeks to better document the intended method for referencing plugin configuration parameters (which is currently achieved by referencing `settings.PLUGINS_CONFIG`). This approach is offered as a more convenient mechanism for plugin authors. ### Database changes _No response_ ### External dependencies _No response_
adam added the status: acceptedtype: featuretopic: plugins labels 2025-12-29 19:48:29 +01:00
adam closed this issue 2025-12-29 19:48:30 +01:00
adam commented 2025-12-29 19:48:30 +01:00
Author
Owner
Copy Link

@cyberndj commented on GitHub (Oct 3, 2022):

Would this mean we could change plugin entries in plugins.py through the web interface?

@cyberndj commented on GitHub (Oct 3, 2022): Would this mean we could change plugin entries in plugins.py through the web interface?
adam commented 2025-12-29 19:48:30 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Oct 3, 2022):

Would this mean we could change plugin entries in plugins.py through the web interface?

No; it has nothing to do with manipulating installed plugins.

@jeremystretch commented on GitHub (Oct 3, 2022): > Would this mean we could change plugin entries in plugins.py through the web interface? No; it has nothing to do with manipulating installed plugins.
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: accepted topic: plugins 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#7065
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?