Plugins, how to add them in the configuration.py properly?

[TheDirkMelvin]

Many plugins require you to add them in the configuration.py file, and the majority of the documentation for said plugins do indeed let you know that....however, in their example they only show THEIR plugin.

So my question is, if I have 15 plugins (wowzers!!! LOL) what should my configuration.py 'PLUGINS section' actually look like?

[candlerb]

It's a python list.

PLUGINS = [
            'my_plugin',
            'netbox_topology_views',
]

And the configuration is a dict:

PLUGINS_CONFIG = {
    'my_plugin': {
        'foo': 'bar',
        'buzz': 'bazz'
    },
    'netbox_topology_views': {
        'device_img': ['router','switch', 'firewall'],
        'preselected_device_roles': ['Router', 'Firewall']
    },
}

[mariano-daniel]

It's a python list.

PLUGINS = [
            'my_plugin',
            'netbox_topology_views',
]

And the configuration is a dict:

PLUGINS_CONFIG = {
    'my_plugin': {
        'foo': 'bar',
        'buzz': 'bazz'
    },
    'netbox_topology_views': {
        'device_img': ['router','switch', 'firewall'],
        'preselected_device_roles': ['Router', 'Firewall']
    },
}

Why would this not work for me?

I have:

# Enable installed plugins. Add the name of each plugin to the list.
#PLUGINS = ['slurpit_netbox']

PLUGINS = [
            'netbox_inventory',
            'netbox_cmdb',
           ]

PLUGINS_CONFIG = {
    'netbox_inventory': {
        # Example settings below, see "Available settings"
        # in README.md for all possible settings
        "used_status_name": "used",
        "stored_status_name": "stored",
        "sync_hardware_serial_asset_tag": True,
    },

 
}

And it breaks my Netbox instance. When I comment out 'netbox_cmdb', it works.

Almost as if it wouldn't like to have a list there.

[candlerb]

Without seeing the error message you get when it "breaks", we can't see what the problem is. Try journalctl -eu netbox

It sounds to me though that the netbox_cmdb plugin is broken or misconfigured, in which case you should take it up with the author of that plugin.

[mariano-daniel]

Thanks @candlerb ! I will open an Issue on their repo.

journalctl -eu netbox:

ESCOD
Aug 05 02:54:11 debian gunicorn[209434]:   File "<frozen importlib._bootstrap>", line 1206, in _gcd_import
Aug 05 02:54:11 debian gunicorn[209434]:   File "<frozen importlib._bootstrap>", line 1178, in _find_and_load
Aug 05 02:54:11 debian gunicorn[209434]:   File "<frozen importlib._bootstrap>", line 1149, in _find_and_load_unlocked
Aug 05 02:54:11 debian gunicorn[209434]:   File "<frozen importlib._bootstrap>", line 690, in _load_unlocked
Aug 05 02:54:11 debian gunicorn[209434]:   File "<frozen importlib._bootstrap_external>", line 940, in exec_module
Aug 05 02:54:11 debian gunicorn[209434]:   File "<frozen importlib._bootstrap>", line 241, in _call_with_frames_removed
Aug 05 02:54:11 debian gunicorn[209434]:   File "/opt/netbox/netbox/netbox/wsgi.py", line 7, in <module>
Aug 05 02:54:11 debian gunicorn[209434]:     application = get_wsgi_application()
Aug 05 02:54:11 debian gunicorn[209434]:                   ^^^^^^^^^^^^^^^^^^^^^^
Aug 05 02:54:11 debian gunicorn[209434]:   File "/opt/netbox-4.0.7/venv/lib/python3.11/site-packages/django/core/wsgi.py", line 12, in get_wsgi_application
Aug 05 02:54:11 debian gunicorn[209434]:     django.setup(set_prefix=False)
Aug 05 02:54:11 debian gunicorn[209434]:   File "/opt/netbox-4.0.7/venv/lib/python3.11/site-packages/django/__init__.py", line 19, in setup
Aug 05 02:54:11 debian gunicorn[209434]:     configure_logging(settings.LOGGING_CONFIG, settings.LOGGING)
Aug 05 02:54:11 debian gunicorn[209434]:                       ^^^^^^^^^^^^^^^^^^^^^^^
Aug 05 02:54:11 debian gunicorn[209434]:   File "/opt/netbox-4.0.7/venv/lib/python3.11/site-packages/django/conf/__init__.py", line 89, in __getattr__
Aug 05 02:54:11 debian gunicorn[209434]:     self._setup(name)
Aug 05 02:54:11 debian gunicorn[209434]:   File "/opt/netbox-4.0.7/venv/lib/python3.11/site-packages/django/conf/__init__.py", line 76, in _setup
Aug 05 02:54:11 debian gunicorn[209434]:     self._wrapped = Settings(settings_module)
Aug 05 02:54:11 debian gunicorn[209434]:                     ^^^^^^^^^^^^^^^^^^^^^^^^^
Aug 05 02:54:11 debian gunicorn[209434]:   File "/opt/netbox-4.0.7/venv/lib/python3.11/site-packages/django/conf/__init__.py", line 190, in __init__
Aug 05 02:54:11 debian gunicorn[209434]:     mod = importlib.import_module(self.SETTINGS_MODULE)
Aug 05 02:54:11 debian gunicorn[209434]:           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Aug 05 02:54:11 debian gunicorn[209434]:   File "/usr/lib/python3.11/importlib/__init__.py", line 126, in import_module
Aug 05 02:54:11 debian gunicorn[209434]:     return _bootstrap._gcd_import(name[level:], package, level)
Aug 05 02:54:11 debian gunicorn[209434]:            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Aug 05 02:54:11 debian gunicorn[209434]:   File "<frozen importlib._bootstrap>", line 1206, in _gcd_import
Aug 05 02:54:11 debian gunicorn[209434]:   File "<frozen importlib._bootstrap>", line 1178, in _find_and_load
Aug 05 02:54:11 debian gunicorn[209434]:   File "<frozen importlib._bootstrap>", line 1149, in _find_and_load_unlocked
Aug 05 02:54:11 debian gunicorn[209434]:   File "<frozen importlib._bootstrap>", line 690, in _load_unlocked
Aug 05 02:54:11 debian gunicorn[209434]:   File "<frozen importlib._bootstrap_external>", line 940, in exec_module
Aug 05 02:54:11 debian gunicorn[209434]:   File "<frozen importlib._bootstrap>", line 241, in _call_with_frames_removed
Aug 05 02:54:11 debian gunicorn[209434]:   File "/opt/netbox/netbox/netbox/settings.py", line 776, in <module>
Aug 05 02:54:11 debian gunicorn[209434]:     raise ImproperlyConfigured(
Aug 05 02:54:11 debian gunicorn[209434]: django.core.exceptions.ImproperlyConfigured: Unable to import plugin netbox_cmdb: Module not found. Check that the plugin module has been installed within the correct Python environment.
Aug 05 02:54:11 debian gunicorn[209434]: [2024-08-05 02:54:11 -0400] [209434] [INFO] Worker exiting (pid: 209434)
Aug 05 02:54:11 debian systemd[1]: netbox.service: Failed with result 'exit-code'.
Aug 05 02:54:11 debian systemd[1]: netbox.service: Consumed 2.693s CPU time.

Instructions I followed:

Installation

Existing NetBox instance

This is simple:

Download the network_cmdb plugin from the [criteo/netbox-network-cmdb](https://github.com/criteo/netbox-network-cmdb) repository.
Place the directory in your NetBox instance.
Open the netbox/configuration.py file and add netbox_cmdb in the PLUGINS list.
Restart your NetBox instance.

From https://criteo.github.io/AFK/CMDB/installation/