Allow configurable separator for {module_path} placeholder #152

New Issue

MrUnknownDE · 2026-04-05T16:22:19+02:00

MrUnknownDE commented

2026-04-05 16:22:19 +02:00

Originally created by @mrmrcoleman on 3/13/2026

NetBox version

v4.5.2

Feature type

Change to existing functionality

Proposed functionality

The {module_path} placeholder (introduced in #21436) currently joins module bay positions with a hardcoded / separator (MODULE_TOKEN_SEPARATOR in dcim/constants.py). This works well for the common <unit>/<slot>/<port> naming convention used by most modern switches and routers, but some hardware uses different separators:

: for channelized interfaces (e.g. 1/2:3)
- for certain legacy platforms
. for sub-interface style naming

It would be useful to allow the separator to be configurable, either:

Per-template: A separator field on component templates that use {module_path}, or
Per-ModuleType: A separator property on the ModuleType itself, or
Globally: A configurable setting (though this is the least flexible option)

Justification

This was raised during review of #21436 by @sleepinggenius2 and @arthanson. The current constant-based approach was chosen deliberately to keep the initial {module_path} implementation simple, with the expectation that configurability could be added as a follow-up.

#21436 (PR introducing {module_path})
NB-1871, NB-1486 (original issues motivating {module_path})

*Originally created by @mrmrcoleman on 3/13/2026* ### NetBox version v4.5.2 ### Feature type Change to existing functionality ### Proposed functionality The `{module_path}` placeholder (introduced in [#21436](<https://github.com/netbox-community/netbox/issues/21436>)) currently joins module bay positions with a hardcoded `/` separator (`MODULE_TOKEN_SEPARATOR` in `dcim/constants.py`). This works well for the common `<unit>/<slot>/<port>` naming convention used by most modern switches and routers, but some hardware uses different separators: * `:` for channelized interfaces (e.g. `1/2:3`) * `-` for certain legacy platforms * `.` for sub-interface style naming It would be useful to allow the separator to be configurable, either: 1. **Per-template:** A separator field on component templates that use `{module_path}`, or 2. **Per-ModuleType:** A separator property on the ModuleType itself, or 3. **Globally:** A configurable setting (though this is the least flexible option) ### Justification This was raised during review of [#21436](<https://github.com/netbox-community/netbox/issues/21436>) by @sleepinggenius2 and @arthanson. The current constant-based approach was chosen deliberately to keep the initial `{module_path}` implementation simple, with the expectation that configurability could be added as a follow-up. ### Related * [#21436](<https://github.com/netbox-community/netbox/issues/21436>) (PR introducing `{module_path}`) * [NB-1871](https://linear.app/netboxlabs/issue/NB-1871/cannot-install-module-with-placeholder-values-in-a-module-bay-tree-2), [NB-1486](https://linear.app/netboxlabs/issue/NB-1486/extend-the-behaviour-of-the-module-variable-in-components-of-module) (original issues motivating `{module_path}`)

MrUnknownDE closed this issue

2026-04-05 16:22:19 +02:00

Sign in to join this conversation.

Branches Tags

main

21455-sql-indexes-audit

21357-register-model-actions

feature

20924-plugin-ui-components

21766-improve-test-coverage-for-sortable-table-columns

21157-export-template-public-models

21025-pre-render-config-contexts

21364-swagger

feature-ip-prefix-link

20911-dropdown-3

fix_module_substitution

21160-filterset

20911-dropdown-2

20044-elevation-stuck-lightmode

7604-filter-modifiers-v3

20660-script-load

19724-graphql

14884-script

19720-macaddress-interface-generic-relation

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

No Label netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github/netbox#152