Replies: 4 comments 12 replies
-
It sounds like you have several ideas, and need some help deciding which one to pursue and developing an implementation proposal. I'm going to convert this to a discussion. Once you've identified a direction and can provide a reasonably detailed proposal, please open a new feature request. Please also be aware that we have several tests in place to validate the current behavior, and that invalidating any of these tests would be considered a break change by many users. |
Beta Was this translation helpful? Give feedback.
-
|
I've encountered this for Arista interfaces as detailed above, it's very annoying. The naturalisation in the function naturalize_interface seems like it should work reasonably for anything? Is this what is used currently? If so, why doesn't it work? In terms of options: I would be more than happy with the padded number ordering. |
Beta Was this translation helpful? Give feedback.
-
|
One of my major complaints at the moment is with Cisco ONS devices, or really any devices that use TL1 AIDs for interface naming, as they use a '-' (hyphen-minus) separator and not a '/' (solidus) separator. As the Current: class Interface(ModularComponentModel, BaseInterface, CabledObjectModel, PathEndpoint, TrackingModelMixin):
"""
A network interface within a Device. A physical Interface can connect to exactly one other Interface.
"""
# Override ComponentModel._name to specify naturalize_interface function
_name = NaturalOrderingField(
target_field='name',
naturalize_function=naturalize_interface,
max_length=100,
blank=True
)
...
# =====
class VMInterface(ComponentModel, BaseInterface, TrackingModelMixin):
name = models.CharField(
verbose_name=_('name'),
max_length=64,
)
_name = NaturalOrderingField(
target_field='name',
naturalize_function=naturalize_interface,
max_length=100,
blank=True
)
# =====
class NaturalOrderingField(models.CharField):
...
def pre_save(self, model_instance, add):
"""
Generate a naturalized value from the target field
"""
original_value = getattr(model_instance, self.target_field)
naturalized_value = self.naturalize_function(original_value, max_length=self.max_length)
setattr(model_instance, self.attname, naturalized_value)
return naturalized_value
# =====
def naturalize_interface(value, max_length):
"""
Similar in nature to naturalize(), but takes into account a particular naming format adapted from the old
InterfaceManager.
:param value: The value to be naturalized
:param max_length: The maximum length of the returned string. Characters beyond this length will be stripped.
"""
output = ''
...Proposed: def get_naturalize_interface_function():
if f := get_config().NATURALIZE_INTERFACE_FUNCTION:
# Loading a naturalize function by a dotted path
if type(f) is str:
module, func = f.rsplit('.', 1)
f = getattr(importlib.import_module(module), func)()
if not callable(f):
raise ImproperlyConfigured(f"Invalid value for naturalize interface function: {f}")
return f
return naturalize_interface
class Interface(ModularComponentModel, BaseInterface, CabledObjectModel, PathEndpoint, TrackingModelMixin):
"""
A network interface within a Device. A physical Interface can connect to exactly one other Interface.
"""
# Override ComponentModel._name to specify naturalize_interface function
_name = NaturalOrderingField(
target_field='name',
naturalize_function=get_naturalize_interface_function(),
max_length=100,
blank=True
)
...
# =====
class VMInterface(ComponentModel, BaseInterface, TrackingModelMixin):
name = models.CharField(
verbose_name=_('name'),
max_length=64,
)
_name = NaturalOrderingField(
target_field='name',
naturalize_function=get_naturalize_interface_function(),
max_length=100,
blank=True
)
# =====
class NaturalOrderingField(models.CharField):
...
def pre_save(self, model_instance, add):
"""
Generate a naturalized value from the target field
"""
naturalized_value = self.naturalize_function(model_instance, self.target_field, max_length=self.max_length)
setattr(model_instance, self.attname, naturalized_value)
return naturalized_value
# =====
def naturalize_interface(model_instance, target_field, max_length):
"""
Similar in nature to naturalize(), but takes into account a particular naming format adapted from the old
InterfaceManager.
:param model_instance: The model instance
:param target_field: The target field to be naturalized
:param max_length: The maximum length of the returned string. Characters beyond this length will be stripped.
"""
value = getattr(model_instance, target_field)
output = ''
... |
Beta Was this translation helpful? Give feedback.
-
|
I created something that seems to work :-)
still todo: re-run the naturaltization when the sorting function changes on the platform |
Beta Was this translation helpful? Give feedback.
-
|
I would like to move this check def get_interfacesorting_function(self):
sortfunction_keys = [sortfunction_dict for sortfunction_dict in InterfaceNaturalizationFunctionChoices.CHOICES]
if not ('default' in sortfunction_keys and 'alphanumeric' in sortfunction_keys):
raise ValueError("The build-in sorting function cannot be removed. "
"If an extra function is added using the FIELD_CHOICES, then make sure to use "
"'dcim.Platform.interfacesorting+' (with a plus at the end) to add the function "
"to the build-in ones")to a check when netbox service is started.. no idea where and how this is the best place |
Beta Was this translation helpful? Give feedback.
-
|
Fixed that, by updating the 'ChoiceSetMeta'. It now allows you to set the ChoiceSet to be extendable and/or replaceable. class ChoiceSetMeta(type):
"""
Metaclass for ChoiceSet
"""
def __new__(mcs, name, bases, attrs):
# Extend static choices with any configured choices
if key := attrs.get('key'):
assert type(attrs['CHOICES']) is list, _(
"{name} has a key defined but CHOICES is not a list"
).format(name=name)
app = attrs['__module__'].split('.', 1)[0]
replace_key = f'{app}.{key}'
replaceable = attrs.get('replaceable', True)
extend_key = f'{replace_key}+' if replace_key else None
extendable = attrs.get('extendable', True)
if replace_key and replace_key in settings.FIELD_CHOICES:
if not replaceable:
raise ValueError(f"The CHOICES key '{replace_key}' cannot replaced "
"by FIELD_CHOICES in configuration.py.")
# Replace the stock choices
attrs['CHOICES'] = settings.FIELD_CHOICES[replace_key]
elif extend_key and extend_key in settings.FIELD_CHOICES:
if not extendable:
raise ValueError(f"The CHOICES key '{replace_key}' cannot be extended "
"by FIELD_CHOICES in configuration.py.")
# Extend the stock choices
attrs['CHOICES'].extend(settings.FIELD_CHOICES[extend_key]) |
Beta Was this translation helpful? Give feedback.
-
Is there a reason why you are not using this for the VMInterface model as well? Network devices seem to increasingly be virtualized and would benefit from the same sorting options. I know in your network we have virtual versions of a number of our physical devices and would need to apply the same sorting algorithms to them. |
Beta Was this translation helpful? Give feedback.
-
|
Brain fart |
Beta Was this translation helpful? Give feedback.
-
|
@jeremystretch Is this something we can move to a FR, or do you have any concerns on this way of implementation |
Beta Was this translation helpful? Give feedback.
-
|
Todo on the POC
|
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
-
NetBox version
v4.2.9
Feature type
Change to existing functionality
Proposed functionality
Interfaces are sorted according a specific interface naturalization function
netbox/netbox/utilities/ordering.py
Line 51 in cf0ef92
This function suits very well for Cisco branded devices, but does not always work for other vendors.
There has been few proposals (can only find this one #9368 ) to address this, but for now non has been accepted,
I see few options
Use case
A recent poll in #netbox shows that there is a need for this: https://netdev-community.slack.com/archives/C01P0FRSXRV/p1757313471550629?thread_ts=1757065483.482359&cid=C01P0FRSXRV
On Arista we have interfaces that are split in lanes, without slot/pos/subpos identifiers.
The current rules sorts them as
Juniper interfaces get different prefixes depending on the speed
get sorted as
Netapp interfaces are even more difficult. they sometimes have a prefix 'e' and sometimes not, but the number is the way to sort
is sorted as
Database changes
No response
External dependencies
No response
Beta Was this translation helpful? Give feedback.
All reactions