Installation

Validity is the NetBox plugin. So, before installing validity you have to install NetBox first. Please refer NetBox docs for how to do it.

System Requirements

Python NetBox
>=3.10 3.5 | 3.6 | 3.7

Installation steps

Once you have installed NetBox, you should follow these steps

  • Install validity using pip
pip install netbox-validity
# configuration.py

PLUGINS = [
    "validity",
    # some other plugins here
]
  • Add Data Source custom validator to prevent creation of more than one Data Source with default=True
#configuration.py

CUSTOM_VALIDATORS = {
    "core.datasource": ["validity.custom_validators.DataSourceValidator"]
}

Warning

According to this NetBox bug custom validation for Data Source does not work prior to NetBox v3.6.6

  • Create DB tables
./manage.py migrate validity
  • Collect static files
./manage.py collectstatic
  • Change plugin settings according to your needs via PLUGINS_CONFIG variable. Read more: Plugin Settings