netbox-load-balancing


Namenetbox-load-balancing JSON
Version 1.2.1 PyPI version JSON
download
home_pageNone
SummaryNetBox Load Balancing is a NetBox plugin that models a Load Balancing service based on the OpenStack SLB modelling
upload_time2025-10-31 07:22:45
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseNone
keywords netbox netbox-plugin load-balancing
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # NetBox Load Balancing Plugin
[Netbox](https://github.com/netbox-community/netbox) plugin for Load Balancing related objects documentation.

<div align="center">
<a href="https://pypi.org/project/netbox-load-balancing/"><img src="https://img.shields.io/pypi/v/netbox-load-balancing" alt="PyPi"/></a>
<a href="https://github.com/andy-shady-org/netbox-load-balancing/stargazers"><img src="https://img.shields.io/github/stars/andy-shady-org/netbox-load-balancing?style=flat" alt="Stars Badge"/></a>
<a href="https://github.com/andy-shady-org/netbox-load-balancing/network/members"><img src="https://img.shields.io/github/forks/andy-shady-org/netbox-load-balancing?style=flat" alt="Forks Badge"/></a>
<a href="https://github.com/andy-shady-org/netbox-load-balancing/issues"><img src="https://img.shields.io/github/issues/andy-shady-org/netbox-load-balancing" alt="Issues Badge"/></a>
<a href="https://github.com/andy-shady-org/netbox-load-balancing/pulls"><img src="https://img.shields.io/github/issues-pr/andy-shady-org/netbox-load-balancing" alt="Pull Requests Badge"/></a>
<a href="https://github.com/andy-shady-org/netbox-load-balancing/graphs/contributors"><img alt="GitHub contributors" src="https://img.shields.io/github/contributors/andy-shady-org/netbox-load-balancing?color=2b9348"></a>
<a href="https://github.com/andy-shady-org/netbox-load-balancing/blob/master/LICENSE"><img src="https://img.shields.io/github/license/andy-shady-org/netbox-load-balancing?color=2b9348" alt="License Badge"/></a>
<a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code Style Black"/></a>
<a href="https://pepy.tech/project/netbox-load-balancing"><img alt="Downloads" src="https://static.pepy.tech/badge/netbox-load-balancing"></a>
<a href="https://pepy.tech/project/netbox-load-balancing"><img alt="Downloads/Week" src="https://static.pepy.tech/badge/netbox-load-balancing/month"></a>
<a href="https://pepy.tech/project/netbox-load-balancing"><img alt="Downloads/Month" src="https://static.pepy.tech/badge/netbox-load-balancing/week"></a>
</div>


## Features

This plugin is based on the OpenStack modelling of [LBaaS](https://docs.openstack.org/mitaka/networking-guide/config-lbaas.html)

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                     |

## 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:
```bash
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](https://netbox.readthedocs.io/en/stable/plugins/)


## 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](CONTRIBUTING.md)


## Documentation

For further information, please refer to the full documentation: [Using NetBox Load Balancer](docs/using_netbox_load_balancing.md)


## 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

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "netbox-load-balancing",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "netbox, netbox-plugin, load-balancing",
    "author": null,
    "author_email": "Andy Wilson <andy@shady.org>",
    "download_url": "https://files.pythonhosted.org/packages/39/f4/cadfa4943d0aa5f253328a3419ad39496e0f42ac1048638a1d045eb4f495/netbox_load_balancing-1.2.1.tar.gz",
    "platform": null,
    "description": "# NetBox Load Balancing Plugin\n[Netbox](https://github.com/netbox-community/netbox) plugin for Load Balancing related objects documentation.\n\n<div align=\"center\">\n<a href=\"https://pypi.org/project/netbox-load-balancing/\"><img src=\"https://img.shields.io/pypi/v/netbox-load-balancing\" alt=\"PyPi\"/></a>\n<a href=\"https://github.com/andy-shady-org/netbox-load-balancing/stargazers\"><img src=\"https://img.shields.io/github/stars/andy-shady-org/netbox-load-balancing?style=flat\" alt=\"Stars Badge\"/></a>\n<a href=\"https://github.com/andy-shady-org/netbox-load-balancing/network/members\"><img src=\"https://img.shields.io/github/forks/andy-shady-org/netbox-load-balancing?style=flat\" alt=\"Forks Badge\"/></a>\n<a href=\"https://github.com/andy-shady-org/netbox-load-balancing/issues\"><img src=\"https://img.shields.io/github/issues/andy-shady-org/netbox-load-balancing\" alt=\"Issues Badge\"/></a>\n<a href=\"https://github.com/andy-shady-org/netbox-load-balancing/pulls\"><img src=\"https://img.shields.io/github/issues-pr/andy-shady-org/netbox-load-balancing\" alt=\"Pull Requests Badge\"/></a>\n<a href=\"https://github.com/andy-shady-org/netbox-load-balancing/graphs/contributors\"><img alt=\"GitHub contributors\" src=\"https://img.shields.io/github/contributors/andy-shady-org/netbox-load-balancing?color=2b9348\"></a>\n<a href=\"https://github.com/andy-shady-org/netbox-load-balancing/blob/master/LICENSE\"><img src=\"https://img.shields.io/github/license/andy-shady-org/netbox-load-balancing?color=2b9348\" alt=\"License Badge\"/></a>\n<a href=\"https://github.com/psf/black\"><img src=\"https://img.shields.io/badge/code%20style-black-000000.svg\" alt=\"Code Style Black\"/></a>\n<a href=\"https://pepy.tech/project/netbox-load-balancing\"><img alt=\"Downloads\" src=\"https://static.pepy.tech/badge/netbox-load-balancing\"></a>\n<a href=\"https://pepy.tech/project/netbox-load-balancing\"><img alt=\"Downloads/Week\" src=\"https://static.pepy.tech/badge/netbox-load-balancing/month\"></a>\n<a href=\"https://pepy.tech/project/netbox-load-balancing\"><img alt=\"Downloads/Month\" src=\"https://static.pepy.tech/badge/netbox-load-balancing/week\"></a>\n</div>\n\n\n## Features\n\nThis plugin is based on the OpenStack modelling of [LBaaS](https://docs.openstack.org/mitaka/networking-guide/config-lbaas.html)\n\nThis plugin provides following Models:\n\n* Services\n* Virtual Pools\n* Virtual IPs\n* Listeners\n* Health Monitors\n* Pools\n* Members\n\n## Compatibility\n\n| NetBox Version | NetBox Load Balancing Version |\n|----------------|-------------------------------|\n| NetBox 4.2     | \\>= 1.0.1                     |\n| NetBox 4.3     | \\>= 1.1.0                     |\n| NetBox 4.4     | \\>= 1.2.0                     |\n\n## Installation\n\nThe plugin is available as a Python package in pypi and can be installed with pip  \n\n```\npip install netbox-load-balancing\n```\nEnable the plugin in /opt/netbox/netbox/netbox/configuration.py:\n```\nPLUGINS = ['netbox_load_balancing']\n```\nRestart NetBox and add `netbox-load-balancing` to your local_requirements.txt\n\nPerform database migrations:\n```bash\ncd /opt/netbox\nsource venv/bin/activate\npython ./netbox/manage.py migrate netbox_load_balancing\npython ./netbox/manage.py reindex netbox_load_balancing\n```\n\nFull documentation on using plugins with NetBox: [Using Plugins - NetBox Documentation](https://netbox.readthedocs.io/en/stable/plugins/)\n\n\n## Configuration\n\nThe following options are available:\n* `service_ext_page`: String (default left) Service related objects table position. The following values are available:  \nleft, right, full_width. Set empty value for disable.\n* `pool_ext_page`: String (default left) Pool related objects table position. The following values are available:  \nleft, right, full_width. Set empty value for disable.\n* `member_ext_page`: String (default left) Member related objects table position. The following values are available:  \nleft, right, full_width. Set empty value for disable.\n* `monitor_ext_page`: String (default left) Health Monitor related objects table position. The following values are available:  \nleft, right, full_width. Set empty value for disable.\n* `top_level_menu`: Boolean (default True) Display plugin menu at the top level. The following values are available: True, False.\n\n\n## Contribute\n\nContributions are always welcome! Please see the [Contribution Guidelines](CONTRIBUTING.md)\n\n\n## Documentation\n\nFor further information, please refer to the full documentation: [Using NetBox Load Balancer](docs/using_netbox_load_balancing.md)\n\n\n## Credits\n\n- Thanks to Peter Eckel for providing some lovely examples which I've happily borrowed, and for providing excellent guidance.\n- Thanks to Gustavo Martinez for assisting with the high level modeling\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "NetBox Load Balancing is a NetBox plugin that models a Load Balancing service based on the OpenStack SLB modelling",
    "version": "1.2.1",
    "project_urls": {
        "Documentation": "https://github.com/andy-shady-org/netbox-load-balancing/blob/main/README.md",
        "Homepage": "https://github.com/andy-shady-org/netbox-load-balancing",
        "Issues": "https://github.com/andy-shady-org/netbox-load-balancing/issues",
        "Repository": "https://github.com/andy-shady-org/netbox-load-balancing"
    },
    "split_keywords": [
        "netbox",
        " netbox-plugin",
        " load-balancing"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "3ac3785ccd504a837ca15ed261789b680698bb4b87d878ee899d9bb0ae2bc598",
                "md5": "40113059422eee3930086f6c3fcf2a45",
                "sha256": "e3ce166ef14caadd30af5770c990275167ac19cbcb640349c7a4e756738bf9cf"
            },
            "downloads": -1,
            "filename": "netbox_load_balancing-1.2.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "40113059422eee3930086f6c3fcf2a45",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 75471,
            "upload_time": "2025-10-31T07:22:44",
            "upload_time_iso_8601": "2025-10-31T07:22:44.273227Z",
            "url": "https://files.pythonhosted.org/packages/3a/c3/785ccd504a837ca15ed261789b680698bb4b87d878ee899d9bb0ae2bc598/netbox_load_balancing-1.2.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "39f4cadfa4943d0aa5f253328a3419ad39496e0f42ac1048638a1d045eb4f495",
                "md5": "e97e9999e5102f5cb311d27984668685",
                "sha256": "03142d132cea6c6e43d050a9a082ee77d12afb11fee37a2b891bcbf1b9e28c4b"
            },
            "downloads": -1,
            "filename": "netbox_load_balancing-1.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "e97e9999e5102f5cb311d27984668685",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 34686,
            "upload_time": "2025-10-31T07:22:45",
            "upload_time_iso_8601": "2025-10-31T07:22:45.477079Z",
            "url": "https://files.pythonhosted.org/packages/39/f4/cadfa4943d0aa5f253328a3419ad39496e0f42ac1048638a1d045eb4f495/netbox_load_balancing-1.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-10-31 07:22:45",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "andy-shady-org",
    "github_project": "netbox-load-balancing",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "netbox-load-balancing"
}
        
Elapsed time: 1.83575s