Move NAPALM proxy functionality to a plugin

[jeremystretch]

NetBox version

v3.3.4

Feature type

Change to existing functionality

Proposed functionality

Move all NALPAM functionality out of NetBox core into a separate plugin that users can install as needed. (This is similar to what we did with secrets in v3.0; see #5278.) This includes:

• Removing the /api/dcim/devices/$id/napalm/ endpoint
• Removing the device status, LLDP neighbors, and configuration UI views
• Removing the napalm_driver and napalm_args from the Platform model

Replicating this functionality in a plugin will require the completion of #9072, to enable the injection of object detail view tabs. Additionally, it will likely require a change to the REST API endpoint.

Use case

NetBox's NAPALM API proxy was never intended to be more than a convenience, and is not encompassed by NetBox's core mission of serving as a source of truth. Additionally, issues concerning changes to NAPALM functionality distract from core development. Some examples include:

• Storing Secrets and Information for NAPALM usage #4980
• Napalm LLDP port names are splitted by dots (.) #7197
• Device Name (Asset Tag) is breaking NAPALM/LLDP  #8079
• Use HTMX to render device status/config/LLDP views #8152
• Cosmetic issue (napalm status tab) #8861
• NAPALM Hostname split at . #10468
• LLDP with stacked members in virtual chassis --> use virtual chassis name instead of the member name #10518

Moving this feature into a standalone project should help draw more development interest, as it will no longer have to compete for attention among core development efforts. It also opens the door for additional functionality via the introduction of new models and API endpoints.

Database changes

No response

External dependencies

No response

[PieterL75]

I'd really love to see a SuzieQ integration also :-)
not as realtime as napalm, but is for sure will be faster :-)

[ryanmerolle]

I'd really love to see a SuzieQ integration also :-) not as realtime as napalm, but is for sure will be faster :-)

This would really help users who want to integrate applications like suzie-q, librenms, zabbix, IP Fabric, Forward Networks, and the like by providing a reference model. I'm not sure the maintainer team is volunteering at this point to develop these plugins in house.

[PieterL75]

Since the tabs can be added by a plugin, i think this is a good step to move napalm to a plugin, and indeed hope that other product maintainers hop on

[renatoalmeidaoliveira]

About the plugin migration, how the mantainer team are thinking about it?
My concern is about multi vendor support, for example it would be ok to add an folder to Netbox folder structure like reports, and scripts for custom parsers?

[jeremystretch]

We've retained the NAPALM fields on the Platform model for now to help with the migration. They'll be removed in a future NetBox release.