Plugin configuration not applying

[RyanMesser]

Hey,
I've been trying to apply the plugin configuration to a docker version of netbox (3.4.2) using plugin version 3.3.0. The plugin is installed correctly and runs, but I can't get the plugin configuration to work.

I've got plugin configuration for the SAML plugin which works fine, but the configuration for topology views doesn't seem to be working. Not sure if there is something missing, but in my configuration.py i have.

PLUGINS = [
    'django3_saml2_nbplugin',
    'netbox_topology_views'
]

PLUGINS_CONFIG = {
      'django3_saml2_nbplugin': {

        # Use the Netbox default remote backend
        'AUTHENTICATION_BACKEND': REMOTE_AUTH_BACKEND,
        # Custom URL to validate incoming SAML requests against
        'ASSERTION_URL': 'urlremoved',

        # Populates the Issuer element in authn reques e.g defined as "Audience URI (SP Entity ID)" in SSO
        'ENTITY_ID': 'urlremoved',

        # Metadata is required, choose either remote url
        'METADATA_AUTO_CONF_URL': '',
        # or local file path
        #'METADATA_LOCAL_FILE_PATH': '/opt/netbox/saml2.xml',

        # Settings for SAML2CustomAttrUserBackend. Optional.
        'CUSTOM_ATTR_BACKEND': {
            # Attribute containing the username. Optional.
            'USERNAME_ATTR': 'http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress',
            # Attribute containing the user's email. Optional.
            'MAIL_ATTR': 'http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress',
            # Attribute containing the user's first name. Optional.
            'FIRST_NAME_ATTR': 'http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname',
            # Attribute containing the user's last name. Optional.
            'LAST_NAME_ATTR': 'http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname',
            # Set to True to always update the user on logon
            # from SAML attributes on logon. Defaults to False.
            'ALWAYS_UPDATE_USER': True,
            # Attribute that contains groups. Optional.
            'GROUP_ATTR': 'http://schemas.microsoft.com/ws/2008/06/identity/claims/groups',
            # Dict of user flags to groups.
            # If the user is in the group then the flag will be set to True. Optional.
            'FLAGS_BY_GROUP': {
                'is_staff': '',
                'is_superuser': ''
            },
            # Dict of SAML groups to NetBox groups. Optional.
            # Groups must be created beforehand in NetBox.
            'GROUP_MAPPINGS': {
                'readonly': ''
            },

      'netbox_topology_views': {
        'static_image_directory': 'netbox_topology_views/img',
        'allow_coordinates_saving': True,
        'always_save_coordinates': True

       }
     }
   }
 }

Hopefully can see where I'm going wrong :)

[dreng]

Hi Ryan,

Hey, I've been trying to apply the plugin configuration to a docker version of netbox (3.4.2) using plugin version 3.3.0. The plugin is installed correctly and runs, but I can't get the plugin configuration to work.

When you write "plugin is installed correctly and runs" you mean it shows up in the left handed menu and you are able to render a topology, right? So why exactly do you think that the plugin configuration doesn't work? Please write down the exact steps you do and describe what you see and what you would expect.

[RyanMesser]

Hi,

We see the topology plugin running in Netbox, and can use the plugin to render topology, we also have custom images working. We configured the following in the configuration.py for the topology plugin, as referenced in my original post. We already have a SAML plugin that takes the configuration from the configuration.py but I'm not sure why the topology plugin isn't.

'allow_coordinates_saving': True,
'always_save_coordinates': True

But when I go to Filter in the plugin menu, save coordinates isn't enabled, and I'm unable to tick it which would be fine if the always_save_coordinates seemed to be working.]

Full steps

1. SAML login to Netbox
2. Go to Topology Views menu on left hand side
3. Click Filter
4. Save Coordinates is greyed out un-ticked

Hopefully enough detail, thanks!

[dreng]

Hi Ryan,

I updated your original post in order to quote the whole code. It looked a bit garbled before. In addition, you should make sure that all lines are correctly indented. That helps a lot when searching for logical errors.

You've put the entry for 'netbox_topology_views' into the 'CUSTOM_ATTR_BACKEND' dictionary. So I'd say, two of the braces at the end should go before the 'netbox_topology_views' section, not after. This might work:

PLUGINS_CONFIG = {
    'django3_saml2_nbplugin': {
        # Use the Netbox default remote backend
        'AUTHENTICATION_BACKEND': REMOTE_AUTH_BACKEND,
        # Custom URL to validate incoming SAML requests against
        'ASSERTION_URL': 'urlremoved',

        # Populates the Issuer element in authn reques e.g defined as "Audience URI (SP Entity ID)" in SSO
        'ENTITY_ID': 'urlremoved',

        # Metadata is required, choose either remote url
        'METADATA_AUTO_CONF_URL': '',
        # or local file path
        #'METADATA_LOCAL_FILE_PATH': '/opt/netbox/saml2.xml',

        # Settings for SAML2CustomAttrUserBackend. Optional.
        'CUSTOM_ATTR_BACKEND': {
            # Attribute containing the username. Optional.
            'USERNAME_ATTR': 'http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress',
            # Attribute containing the user's email. Optional.
            'MAIL_ATTR': 'http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress',
            # Attribute containing the user's first name. Optional.
            'FIRST_NAME_ATTR': 'http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname',
            # Attribute containing the user's last name. Optional.
            'LAST_NAME_ATTR': 'http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname',
            # Set to True to always update the user on logon
            # from SAML attributes on logon. Defaults to False.
            'ALWAYS_UPDATE_USER': True,
            # Attribute that contains groups. Optional.
            'GROUP_ATTR': 'http://schemas.microsoft.com/ws/2008/06/identity/claims/groups',
            # Dict of user flags to groups.
            # If the user is in the group then the flag will be set to True. Optional.
            'FLAGS_BY_GROUP': {
                'is_staff': '',
                'is_superuser': ''
            },
            # Dict of SAML groups to NetBox groups. Optional.
            # Groups must be created beforehand in NetBox.
            'GROUP_MAPPINGS': {
                'readonly': ''
            },
        },
    },
    'netbox_topology_views': {
        'static_image_directory': 'netbox_topology_views/img',
        'allow_coordinates_saving': True,
        'always_save_coordinates': True
    }
}

[RyanMesser]

Hi,

I copied from VS Code and it looked fine, so I'm not sure.

I will try with the reposition of braces as I can see what ylu mean.

[RyanMesser]

Moving the breaces from the end of the netbox_topology_views to the end of the 'CUSTOM_ATTR_BACKEND' dictionary, was the fix thanks. I had thought it was going to be something like that, my knowledge of python is growing.