Skip to main content

NetBox Load Balancing is a NetBox plugin that models a Load Balancing service based on the OpenStack SLB modelling

Project description

NetBox Load Balancing Plugin

Netbox plugin for Load Balancing related objects documentation.

PyPi Stars Badge Forks Badge Issues Badge Pull Requests Badge GitHub contributors License Badge Code Style Black Downloads Downloads/Week Downloads/Month

Features

This plugin is based on the OpenStack modelling of LBaaS

This plugin provides following Models:

  • Services
  • Virtual Pools
  • Virtual IPs
  • Listeners
  • Health Monitors
  • Pools
  • Members

Compatibility

NetBox Version NetBox Load Balancing Version
NetBox 4.2 >= 1.0.1
NetBox 4.3 >= 1.1.0
NetBox 4.4 >= 1.2.0
NetBox 4.5 >= 1.3.0

Installation

The plugin is available as a Python package in pypi and can be installed with pip

pip install netbox-load-balancing

Enable the plugin in /opt/netbox/netbox/netbox/configuration.py:

PLUGINS = ['netbox_load_balancing']

Restart NetBox and add netbox-load-balancing to your local_requirements.txt

Perform database migrations:

cd /opt/netbox
source venv/bin/activate
python ./netbox/manage.py migrate netbox_load_balancing
python ./netbox/manage.py reindex netbox_load_balancing

Full documentation on using plugins with NetBox: Using Plugins - NetBox Documentation

Configuration

The following options are available:

  • service_ext_page: String (default left) Service related objects table position. The following values are available:
    left, right, full_width. Set empty value for disable.
  • pool_ext_page: String (default left) Pool related objects table position. The following values are available:
    left, right, full_width. Set empty value for disable.
  • member_ext_page: String (default left) Member related objects table position. The following values are available:
    left, right, full_width. Set empty value for disable.
  • monitor_ext_page: String (default left) Health Monitor related objects table position. The following values are available:
    left, right, full_width. Set empty value for disable.
  • top_level_menu: Boolean (default True) Display plugin menu at the top level. The following values are available: True, False.

Contribute

Contributions are always welcome! Please see the Contribution Guidelines

Documentation

For further information, please refer to the full documentation: Using NetBox Load Balancer

Credits

  • Thanks to Peter Eckel for providing some lovely examples which I've happily borrowed, and for providing excellent guidance.
  • Thanks to Gustavo Martinez for assisting with the high level modeling

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

netbox_load_balancing-1.3.4.tar.gz (36.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

netbox_load_balancing-1.3.4-py3-none-any.whl (82.7 kB view details)

Uploaded Python 3

File details

Details for the file netbox_load_balancing-1.3.4.tar.gz.

File metadata

  • Download URL: netbox_load_balancing-1.3.4.tar.gz
  • Upload date:
  • Size: 36.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for netbox_load_balancing-1.3.4.tar.gz
Algorithm Hash digest
SHA256 b8dbde2c0961392470ff7c9bee60ae125f4d0f576598c56ae8cf03da8fc33f08
MD5 4cc27babb43af37a2f16c893060b6f76
BLAKE2b-256 35bdf5c3cb61a74a3e7ecbc174943c2cb1c72f0708f49280ad90efbdbaf6f506

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_load_balancing-1.3.4.tar.gz:

Publisher: publish.yml on andy-shady-org/netbox-load-balancing

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file netbox_load_balancing-1.3.4-py3-none-any.whl.

File metadata

File hashes

Hashes for netbox_load_balancing-1.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 f55783a2586d29230765d14ebe21900f0ed4de32af71687ea78daf898d9d2b24
MD5 265be21dbe97e1e3b6a81156c549bf12
BLAKE2b-256 1ce756c5b1297fe8d8569f7fa877eef8d61bc3d751ad69c71751c6ed0279cd99

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_load_balancing-1.3.4-py3-none-any.whl:

Publisher: publish.yml on andy-shady-org/netbox-load-balancing

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page