Saravanan666/pypi-org huggingface dataset:
Package: netbox-giftwrap
netbox_giftwrapTransform NetBox APIs into Business Ready formatsInstalling netbox_giftwrapTo install netbox_giftwrap there are a few simple steps:Ubuntu LinuxThe following instructions are based on Windows WSL2 and Ubuntu however any flavour of Linux will work with possibly slightly different commands.Confirm Python 3 is installed$python3-VPython 3.9.10Create and activate a virtual environment$sudoaptinstallpython3-venv$python3-mvenvnetbox_giftwrap$sourcenetbox_giftwrap/bin/activate(netbox_giftwrap)$Install the netbox_giftwrap(netbox_giftwrap)$pipinstallnetbox_giftwrapCreate an output folder(netbox_giftwrap)$mkdiroutputWindowsDownload PythonCreate and activate a virtual environmentC:\>python3 -m venv netbox_giftwrapC:\>netbox_giftwrap\Scripts\activate(netbox_giftwrap)C:\>Install netbox_giftwrap(message_room)$pipinstallnetbox_giftwrapCreate an output folder(netbox_giftwrap)$mkdiroutputUsing the botRun the bot as an interactive session(netbox_giftwrap)$cdoutput(netbox_giftwrap)$~/output/netbox_giftwrap.pyThe form questions:Question 1 - NetBox URL:Enter the URL of your NetBox instance (e.g.https://demo.netbox.dev):This can be set as an environment variableQuestion 2 - NetBox API Token:Enter your NetBox API Token - you can create / retrieve one fromhttps://URL/user/api-tokens/This can be set as an environment variableCurrent API Coveraaggregatesasnscablescircuit-terminationscircuit-typescircuitscluster-groupscluster-typesclustersconsole-port-templatesconsole-portscontact-assignmentscontact-groupscontact-rolescontactsdevice-bay-templatesdevice-baysdevice-rolesdevice-typesdevicesfront-port-templatesfront-portsgroupsinterface-templatesinterfacesinventory-itemsip-addressesip-rangeslocationsmanufacturersmodule-bay-templatesmodule-baysmodule-typesmodulesplatformspower-feedspower-outlet-templatespower-outletspower-panelspower-port-templatespower-portsprefixesprovider-networksprovidersrack-reservationsrack-rolesracksrear-port-templatesrear-portsregionsrirsrolesroute-targetsservice-templatesservicessite-groupssitesstatustenant-groupstenantstokensusersvirtual-chassisvirtual-interfacesvirtual-machinesvlan-groupsvlans
Package: netbox-gitlab
GitLab export to Ansible Inventory for NetBoxCompatibilityThis plugin in compatible withNetBox2.8 and later.InstallationFirst, addnetbox_gitlabto your/opt/netbox/local_requirements.txtfile. Create it if it doesn't exist.If you are using a local version of the plugin, for example for development, add-e /opt/path/to/plugininstead.Then enable the plugin in/opt/netbox/netbox/netbox/configuration.py, like:PLUGINS=['netbox_gitlab',]The plugin needs to be configured. The following settings are required:PLUGINS_CONFIG={'netbox_gitlab':{'url':'https://gitlab.example.com','private_token':'aBcDeFgHiJkLmNoPqRsTuVwXyZ','project_path':'group/project',},}This example would correspond to the project athttps://gitlab.example.com/group/project.And finally run/opt/netbox/upgrade.sh. This will download and install the plugin and update the database when
necessary. Don't forget to runsudo systemctl restart netbox netbox-rqlikeupgrade.shtells you!UsageThis plugin uses NetBox export templates to generate the files that are put into the git repository. The output of these templates is parsed as YAML, but JSON output is also accepted (as all valid JSON is also valid YAML). Generating JSON can be more convenient because of the more relaxed parsing of indentation.By default this plugin looks for these export templates:Content typeNamePurposedcim > deviceAnsible InventoryA single file listing all devicesdcim > deviceAnsible DeviceOne file per device with device-level configurationdcim > interfaceAnsible InterfacesOne file per device with its interface configurationsThe output sent to GitLab for the inventory is exactly what the export template produces. The output sent to GitLab for device and interface configurations is always YAML with all the empty variables omitted. This makes it easier when writing export templates while still keeping the output compact. This in turn helps to keep Ansible a bit faster by reducing the time spent on parsing the YAML.For the devices export template this plugin expects the generated YAML/JSON to be a mapping with the device name as the key. When a device is part of a virtual chassis all members of the virtual chassis will be included.For the interfaces export template this plugin expects the generated YAML/JSON to be a mapping with the interface name as the key.Examples of export templates are provided in the git repository of this plugin.
Package: netbox-healthcheck-plugin
NetBox HealthCheck PluginNetBox provides health check monitors that can be queried to make sure that the service is running in good condition.NetBox exposes metrics at the/healthcheckHTTP endpoint, e.g.https://netbox.local/healthcheck. It allows monitor conditions via HTTP(S), with responses available in HTML and JSON formats.Free software: Apache-2.0Documentation:https://netbox-community.github.io/netbox-healthcheck-plugin/.FeaturesThe features the plugin provides should be listed here.CompatibilityNetBox VersionPlugin Version3.4 - 3.60.1.0InstallingFor adding to a NetBox Docker setup seethe general instructions for using netbox-docker with plugins.While this is still in development and not yet on pypi you can install with pip:pipinstallgit+https://github.com/netbox-community/netbox-healthcheck-pluginor by adding to yourlocal_requirements.txtorplugin_requirements.txt(netbox-docker):git+https://github.com/netbox-community/netbox-healthcheck-pluginEnable the plugin in/opt/netbox/netbox/netbox/configuration.py,
or if you use netbox-docker, your/configuration/plugins.pyfile :PLUGINS=["netbox_healthcheck_plugin",]PLUGINS_CONFIG={"netbox_healthcheck_plugin":{},}Setting up MonitoringNetBox makes use of thedjango-health-checklibrary, more information on setting up monitors can be found atSetting up Monitoring:CreditsBased on the NetBox plugin tutorial:demo repositorytutorialThis package was created withCookiecutterand thenetbox-community/cookiecutter-netbox-pluginproject template.
Package: netbox-initializers
Netbox Initializers PluginLoad data from YAML files into NetboxInstallationFirst activate your virtual environment where Netbox is installed, the install the plugin version correspondig to your Netbox version.pipinstall"netbox-initializers==3.7.*"Then you need to add the plugin to thePLUGINSarray in the Netbox configuration.PLUGINS=['netbox_initializers',]Getting startedAt first you need to start with writing the YAML files that contain the initial data. To make that easier the plugin includes example files for all supported initializers. To access those examples you can copy them into a directory of your choosing and edit them there. To copy the files run the following command (in your Netbox directory):./manage.pycopy_initializers_examples--path/path/for/example/filesAfter you filled in the data you want to import, the import can be started with this command:./manage.pyload_initializer_data--path/path/for/example/filesNetbox Docker imageThe initializers where a part of the Docker image and where then extracted into a Netbox plugin. This was done to split the release cycle of the initializers and the image.
To use the new plugin in a the Netbox Docker image, it musst be installad into the image. To this, the following example can be used as a starting point:FROMnetboxcommunity/netbox:v3.7RUN/opt/netbox/venv/bin/pipinstall"netbox-initializers==3.7.*"
Package: netbox-interface-sync
netbox-interface-syncРусская версияOverviewThis plugin allows you to compare and synchronize interfaces between devices and device types in NetBox. It can be useful for finding and correcting inconsistencies between interfaces.Tested with NetBox versions 2.10, 2.11InstallationIf your NetBox installation uses virtualenv, activate it like this:source /opt/netbox/venv/bin/activateInstall the plugin from PyPI:pip install netbox-interface-syncor clone this repository, then go to the folder with it and install the plugin:pip install .To enable to plugin, add the plugin's name to thePLUGINSlist inconfiguration.py(it's usually located in/opt/netbox/netbox/netbox/) like so:PLUGINS = [
    'netbox_interface_sync'
]Don't forget to restart NetBox:sudo systemctl restart netboxUsageTo compare the interfaces, open the page of the desired device and find the "Interface sync" button:Mark the required actions with the checkboxes and click "Apply".Plugin settingsIf you want to override the default values, configure thePLUGINS_CONFIGin yourconfiguration.py:PLUGINS_CONFIG = {
    'netbox_interface_sync': {
        'exclude_virtual_interfaces': True
    }
}SettingDefault valueDescriptionexclude_virtual_interfacesTrueExclude virtual interfaces (VLANs, LAGs) from comparison
Package: netbox-ipmi-ovh
Netbox IPMI OVH PluginA plugin used to add a button in the dcim.device to allow easier access to the IPMI for OVH managed bare metal servers.
Tested on NetBox v2.11.12, v3.0.0 and v3.1.7.InstallationThis follow the process of installing a plugin in NetBox [https://netbox.readthedocs.io/en/stable/plugins/]Package Installation from PyPi, from the netbox virtualenvsource /opt/netbox/venv/bin/activate
pip install netbox-ipmi-ovh
cd /opt/netbox/netbox/
python3 manage.py migratePackage Installation from sourcegit clone https://github.com/sanecz/netbox-ipmi-ovh
cd netbox-ipmi-ovh
source /opt/netbox/venv/bin/activate
pip3 install .
cd /opt/netbox/netbox/
python3 manage.py migrateEnable the pluginTo enable the plugin, add/update in theconfiguration.pyfilePLUGINS=['nextbox_ipmi_ovh',]PLUGINS_CONFIG={'netbox_ipmi_ovh_plugin':{'ovh_server_name_field':'existing field or custom field','ovh_endpoint_field':'existing or custom field','endpoints':{'account1-ovh-eu':{'endpoint':'ovh-eu','application_key':'xxxx','application_secret':'yyyy','consumer_key':'zzzz'},'account2-soyoustart-ca':{'endpoint':'soyoustart-ca','application_key':'xxxx','application_secret':'yyyy','consumer_key':'zzzz'}}}}The fieldsovh_server_name_field,ovh_endpoint_fieldandendpointsare mandatory.Restart Netboxsudo systemctl restart netboxRequired permissionsTo be able to use the plugin, a user should have the following permissions:netbox_ipmi_ovh.view_ipmiUsageA button will be present in dcim.devices to select the type of IPMI access you want to use. As of 01/02/2022, only kvmipHtml5URL, kvmipJnlp, serialOverLanURL and serialOverLanSshKey are available.You can create custom fields to store required informations for the plugin to work (i.e the server name from OVH and the endpoint used for the api calls) or use existing fields (like asset tag or serial number of even the name), but be careful to fill correctlyovh_endpoint_fieldandovh_server_name_fieldwith the name of the fields you want to use, there is no default value.
Package: netbox-ipv4-tools
netbox-ipv4-toolsWork with ipv4 in NetBox.
This project includes code fromnetmask(rewritten in Vanilla Javascript), which is licensed under the MIT license:original licenseThis plugin offers a place to retrieveA table with the CIDR to netmask conversion, inluding the wildcard bits and the total hosts available per CIDRA tool to convert a CIDR into an IP range including information such the usable host count, the netmask in decimal dotted format and the wildcard bitsInstallThe plugin is available as a Python package and can be installed with pip.Runpip install netbox-ipv4-toolsin your virtual env.Create a file namedlocal_requirements.txt(if not already existing) in the NetBox root directory (alongsiderequirements.txt) and list thenetbox-ipv4-toolspackage:# echo netbox-ipv4-tools >> local_requirements.txtOnce installed, the plugin needs to be enabled in yourconfiguration.py# In your configuration.pyPLUGINS=["netbox_ipv4_tools"]First runsource /opt/netbox/venv/bin/activateto enter the Python virtual environment.Then runcd/opt/netbox/netbox
pip3installnetbox-ipv4-tools
python3manage.pycollectstatic--no-inputVersionsThis plugin requires netbox >= 3.4.0ThanksThanks torsfor the work onnetmaskThanks tomattieserverand his projectnetbox-topology-view. I used his work to get a working plugin and to publish it to pypi
Package: netbox-is-risks
Netbox plugin 'IS Risks'Добавляет:в Netbox объект "Risk"в карточки объектов virtual machine, device секцию "Risks"Позволяет связывать активы с рисками ИБ и недопустимыми событиями.УстановкаУстановить плагинpip3 install netbox-is-risksДобавить плагин вnetbox/netbox/netbox/configuration.py(обновить или добавить переменную):PLUGINS=['risks']Перейти в каталог с файломmanage.pyи выполнить миграцию БДpython3 manage.py migrateПерезапустить сервер netboxПроверить, что плагин появился в списке установленных плагинов в административном интерфейсе Django.
Package: netbox-kafka-producer
IntroductionThis module provides middleware to publishNetBoxchanges toKafka.Installationpip install netbox-kafka-producerConfigurationAdd the following to your NetBox settings.INSTALLED_APPS += (
	'netbox_kafka_producer',
)

MIDDLEWARE += (
	'netbox_kafka_producer.middleware.KafkaChangeMiddleware',
)

KAFKA = {
	'SERVERS': 'kafka01,kafka02,kafka03',
	'TOPIC':   'netbox',
}
Package: netbox-kea
NetBox plugin for the Kea DHCP serverThis plugin allows you to view Kea status, leases and subnets in NetBox. Go directly from a NetBox device/VM to a DHCP lease and back!FeaturesUses the Kea management APIView Kea daemon statuses.Supports Kea's DHCPv4 and DHCPv6 servers.View, delete, export and search for DHCP leases.Search for NetBox devices/VMs directly from DHCP leases.View DHCP subnets from Kea's configuration.REST API and GraphQL support for managing Server objects.LimitationsDue to limitations in the Kea management API, pagination is only supported when searching for leases by subnet.
Additionally, you can only go forwards, not backwards.Searching for leases by subnet ID does not support pagination. This may be an expensive operation depending on the subnet size.Kea doesn't provide a way to get a list of subnets without an additional hook library.
Thus, this plugin lists subnets using theconfig-getcommand. This means that the entire config will be fetched just to get the configured subnets!
This may be an expensive operation.RequirementsNetBox > v3.5Kea Control Agentlease_cmdshook libraryCompatibilityThis plugin was tested with Kea v2.2.0 with thememfilelease database.
Other versions and lease databases may also work.InstallationAddnetbox-keatolocal_requirements.txt.Enable the plugin inconfiguration.pyPLUGINS=["netbox_kea"]Run./manage.py migrateCustom LinksYou can add custom links to NetBox models to easily search for leases.Make sure to replace<Kea Server ID>in the link URL with the object ID of your Kea server. To find a server's ID, open the page for the server
and look at the top right corner fornetbox_kea.server:<Server ID Here>.Show DHCP leases for a prefixContent types:IPAM > PrefixLink URL:https://netbox.example.com/plugins/kea/servers/<Kea Server ID>/leases{{ object.prefix.version }}/?q={{ object.prefix }}&by=subnetShow DHCP leases for a device/VM interface (by MAC):Content types:DCIM > Interface,Virtualization > InterfaceLink URL (DHCPv4):https://netbox.example.com/plugins/kea/servers/<Kea Server ID>/leases4/?q={{ object.mac_address }}&by=hwLink URL (DHCPv6):https://netbox.example.com/plugins/kea/servers/<Kea Server ID>/leases6/?q={{ object.mac_address }}&by=hwShow DHCP leases for a device/VM (by name):Content types:DCIM > Device,Virtualization > Virtual MachineLink URL (DHCPv4):https://netbox.example.com/plugins/kea/servers/<Kea Server ID>/leases4/?q={{ object.name|lower }}&by=hostnameLink URL (DHCPv4):https://netbox.example.com/plugins/kea/servers/<Kea Server ID>/leases6/?q={{ object.name|lower }}&by=hostnameYou may also use a custom field by replacing{{ object.name|lower }}with{{ object.cf.<your custom field>|lower }}.
Package: netboxlabs-diode-netbox-plugin
Diode NetBox PluginInstallationpipinstallnetboxlabs-diode-netbox-pluginIn yourconfiguration.pyfile, addnetbox_diode_pluginto thePLUGINSlist.PLUGINS=["netbox_diode_plugin",]Create a plugin configuration entry:PLUGINS_CONFIG={"netbox_diode_plugin":{}}
Package: netbox-more-metrics
netbox-more-metricsCreate custom metrics and export information from NetBox into your timeseries database.CompatibilityNetBox VersionPlugin Version3.40.1.X, 0.2.XInstallingFor adding to a NetBox Docker setup seethe general instructions for using netbox-docker with plugins.Installpipinstallnetbox-more-metricsor by adding to yourlocal_requirements.txtorplugin_requirements.txt(netbox-docker):netbox-more-metricsDevelopment InstallIf you would like to install a version not yet published to pypi.pipinstallgit+https://github.com/TheDJVG/netbox-more-metricsor by adding to yourlocal_requirements.txtorplugin_requirements.txt(netbox-docker):git+https://github.com/TheDJVG/netbox-more-metricsNetBox ConfigurationEnable the plugin in/opt/netbox/netbox/netbox/configuration.py,
or if you use netbox-docker, your/configuration/plugins.pyfile :PLUGINS=['netbox_more_metrics']FeaturesCustom metricsFor example, you could track the amount of active devices over time by rack and siteAny model can be exported, data is grouped by the labels.Filter validationEvery filter is tested on save and also when the metric is initiated for exporting.Heavy lifting is done by the databaseAs much as possible is done in the database directly to take advantage of any Model specific optimizations.nulldatabase values are converted to a string"null".FunctionsMetrics can be included in the global metric endpoint (/metrics).Metrics and MetricCollections can be individually exported (as long as the Metric(Collection) is enabled)Future ideasAdding a way to export utilization (e.g. how many IPs of a prefix are used, or how much power is still available on a feed).More ideas welcome!MissingTestsDocumentation
Package: netbox-napalm-plugin
NetBox Napalm PluginNetBox plugin for Napalm.Free software: Apache-2.0Documentation:https://netbox-community.github.io/netbox-napalm/.FeaturesThe features the plugin provides should be listed here.Compatibility:warning:NetBox 3.5: This plugin is for NetBox 3.5NetBox VersionPlugin Version3.50.1.03.5.80.1.43.6.00.1.53.7.0 >0.1.7InstallationFor adding to a NetBox Docker setup seethe general instructions for using netbox-docker with plugins.$ source /opt/netbox/venv/bin/activate
(venv) pip install netbox-napalm-pluginor by adding to yourlocal_requirements.txtorplugin_requirements.txt(netbox-docker):(venv) netbox-napalm-pluginEnable the PluginEnable the plugin in/opt/netbox/netbox/netbox/configuration.py,
or if you use netbox-docker, your/configuration/plugins.pyfile :PLUGINS = [
    'netbox_napalm_plugin'
]Configure PluginConfigure the plugin inconfiguration.pyunder thePLUGINS_CONFIGparameter.PLUGINS_CONFIG = {
    'netbox_napalm_plugin': {
        'NAPALM_USERNAME': 'xxx',
        'NAPALM_PASSWORD': 'yyy',
    },
}Run Database MigrationsRun the provided schema migrations:(venv) $ cd /opt/netbox/netbox/
(venv) $ python3 manage.py migrateCollect Static FilesEnsure the static files are copied to the static root directory with thecollectstaticmanagement command:(venv) $ cd /opt/netbox/netbox/
(venv) $ python3 manage.py collectstaticRestart WSGI ServiceRestart the WSGI service to load the new plugin:# sudo systemctl restart netboxCreditsBased on the NetBox plugin tutorial:demo repositorytutorialThis package was created withCookiecutterand thenetbox-community/cookiecutter-netbox-pluginproject template.
Package: netbox-nas
netbox-nasA plugin to enable managment of NAS resources.This plugin introduces four new models:NAS Cluster: The NAS resource provider, e.g. a NAS head node or cluster of nodes. NetBox Devices can be linked to this.NAS Volume: The share backing volume used by the NAS cluster.NAS Share: The share itself, e.g. NFS export, CIFS share, CephFS path, etc.NAS Mount: The mount definition. This describes how a share should be mounted on a particular resource. NetBox Devices, Virtual Machines, and Prefixes can be linked to this currently.
Package: netbox-netdev-inventory
netbox-netprod-importer is a tool dedicated to help moving your current
knowledge base toNetboxas an
IPAM/DCIM, independently of your current information system. It connects to
a given list of network devices, parse their status and configuration to
import them into Netbox like they are currently configured.It is thought to be generic and infrastructure agnostic. It means that imported
data will probably need to be adapted by some custom scripts, like the
specification of roles, tennant and other properties on objects.DocumentationDocumentation is availablehere.FeaturesDevice’s data:Fetch interfaces (physical & virtual):Try to guess the interface form factor (more info in the documentation)MTUMAC AddressDescriptionParent LAGEnabled/DisabledIPv4/IPv6Serial numberMain IPv4/IPv6Devices interconnections:Build an interconnection graph by using LLDP and CDP to add (and optionally clean)
interconnections between devices in NetboxCompatibilityTested on:Cisco IOS (catalyst, 2960)Cisco Nexus (6000, 9000)Cisco ASR (but no specific parser written, some features are not available)JuniperInstallationRun:pip3 install netbox-netdev-inventorynetbox-netdev-inventory is tested under python 3.5 to 3.7ContributorsVictor Pavlushin <victor@pavlushin.info>LicenseTool under the GPLv3 license. Do not hesitate to report bugs, ask me some
questions or do some pull request if you want to!
Package: netbox_netprod_importer
netbox-netprod-importer is a tool dedicated to help moving your current
knowledge base toNetboxas an
IPAM/DCIM, independently of your current information system. It connects to
a given list of network devices, parse their status and configuration to
import them into Netbox like they are currently configured.It is thought to be generic and infrastructure agnostic. It means that imported
data will probably need to be adapted by some custom scripts, like the
specification of roles, tennant and other properties on objects.Used byScalewayon more than 5000 network
devices.DocumentationDocumentation is availablehere.FeaturesDevice’s data:Fetch interfaces (physical & virtual):Try to guess the interface form factor (more info in the documentation)MTUMAC AddressDescriptionParent LAGEnabled/DisabledIPv4/IPv6Serial numberMain IPv4/IPv6Devices interconnections:Build an interconnection graph by using LLDP to add (and optionally clean)
interconnections between devices in NetboxCompatibilityTested on:Cisco IOS (catalyst, 2960)Cisco Nexus 9000Cisco ASR (but no specific parser written, some features are not available)JuniperInstallationRun:pip3 install netbox-netprod-importernetbox-netprod-importer is tested under python 3.5 to 3.7ContributorsTool initially developed byScaleway.Anthony Ruhier <anthony.ruhier@gmail.com>LicenseTool under the GPLv3 license. Do not hesitate to report bugs, ask me some
questions or do some pull request if you want to!
Package: netbox-nornir
Netbox Nornir PluginAn App forNetbox.OverviewThe Netbox Nornir plugin is a shim layer for OpticoreIT netbox plugins. OpticoreIT use this plugin as a base for network automation solutions. The plugin is based on anautobot-nornircreated by NTC.Main functions:Nornir inventory for Netbox ORMGeneric credentials integrationsGeneric data collection from different device typesInstallationInstall the package using pip:pipinstallnetbox-nornirAdd plugin toPLUGINSin configuration:PLUGINS=[..."netbox_nornir",...]
Package: netbox-old-search
netbox-old-searchThis plugin brings back the old global search method that was used in netbox prior to NetBox v3.4.0. The plugin is intended for users that prefer the old search method, or prefers to have the option to use both.Version CompatibilityShould work with all current versions of NetBox >= v3.4.0.InstallingWith pip:pipinstallnetbox-old-searchThen add tolocal_requirements.txt:netbox-old-searchConfigurationEnable the plugin in/opt/netbox/netbox/netbox/configuration.py:PLUGINS=["netbox_old_search"]PLUGINS_CONFIG={"netbox_old_search":{"replace_search":True,# Hijacks the top search bar in netbox, redirecting to this plugins search method instead"show_menu":False,# Shows a link to the old search form in the plugin menu},}AttributionA lot of the code is repurposed from thenetboxsource code from before the old search engine was removed.Screenshots