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

Merge report functionality into custom scripts #3762

New Issue
Closed
opened 2025-12-29 18:31:06 +01:00 by adam · 4 comments
adam commented 2025-12-29 18:31:06 +01:00
Owner
Copy Link

Originally created by @jeremystretch on GitHub (Jun 9, 2020).

Environment

  • Python version: 3.6.9
  • NetBox version: 2.8.5

Proposed Functionality

Remove the reports feature from NetBox, to be replaced by custom scripts.

Use Case

Reports were added in NetBox v2.2. They allowed the user to execute custom logic within NetBox and save output comprising discrete log messages to the database as a "report result." NetBox v2.6 introduced custom scripts, which are very similar to reports, but had the ability to process user input. However, they lack the ability to persist any output beyond what is immediately returned to the user upon execution.

As there is substantial functional overlap between reports and custom scripts, it makes sense to merge the two features. Once #2006 has been implemented, we can provide a migration path for converting reports into scripts and eventually drop support for reports entirely. A current report will effectively become simply a script which does not take any user input.

Database Changes

Removal of the ReportResult model, to be replaced under #2006.

External Dependencies

None

Originally created by @jeremystretch on GitHub (Jun 9, 2020). ### Environment * Python version: 3.6.9 * NetBox version: 2.8.5 ### Proposed Functionality Remove the reports feature from NetBox, to be replaced by custom scripts. ### Use Case Reports were added in NetBox v2.2. They allowed the user to execute custom logic within NetBox and save output comprising discrete log messages to the database as a "report result." NetBox v2.6 introduced custom scripts, which are very similar to reports, but had the ability to process user input. However, they lack the ability to persist any output beyond what is immediately returned to the user upon execution. As there is substantial functional overlap between reports and custom scripts, it makes sense to merge the two features. Once #2006 has been implemented, we can provide a migration path for converting reports into scripts and eventually drop support for reports entirely. A current report will effectively become simply a script which does not take any user input. ### Database Changes Removal of the ReportResult model, to be replaced under #2006. ### External Dependencies None
adam added the type: feature label 2025-12-29 18:31:06 +01:00
adam closed this issue 2025-12-29 18:31:06 +01:00
adam commented 2025-12-29 18:31:06 +01:00
Author
Owner
Copy Link

@darcynz commented on GitHub (Jul 15, 2020):

Will custom scripts be able to visualize the scoring of validation that is used for reports?. Ie # Success, #Warning & #Failed

@darcynz commented on GitHub (Jul 15, 2020): Will custom scripts be able to visualize the scoring of validation that is used for reports?. Ie # Success, #Warning & #Failed
adam commented 2025-12-29 18:31:06 +01:00
Author
Owner
Copy Link

@ryanmerolle commented on GitHub (Oct 13, 2020):

Needs more discussion & migration plan.

Bumped to v2.11 because possible larger implications that @lampwins and @jeremystretch would like to hash out.

@ryanmerolle commented on GitHub (Oct 13, 2020): Needs more discussion & migration plan. Bumped to v2.11 because possible larger implications that @lampwins and @jeremystretch would like to hash out.
adam commented 2025-12-29 18:31:06 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Mar 2, 2021):

Not sure it makes sense to proceed with this given it hasn't gotten much interest from the community. We should avoid forcing people to rewrite their scripts/reports unless there's a pressing need to do so. I'm going to bump this from v2.11 but keep it open for further discussion.

@jeremystretch commented on GitHub (Mar 2, 2021): Not sure it makes sense to proceed with this given it hasn't gotten much interest from the community. We should avoid forcing people to rewrite their scripts/reports unless there's a pressing need to do so. I'm going to bump this from v2.11 but keep it open for further discussion.
adam commented 2025-12-29 18:31:07 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Mar 29, 2021):

Ditching this proposal as it just seems to add more work for report & script authors where it's not needed.

@jeremystretch commented on GitHub (Mar 29, 2021): Ditching this proposal as it just seems to add more work for report & script authors where it's not needed.
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 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#3762
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?