Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Inconsistent labelling of "mgmt_only" flag #5569

Closed
candlerb opened this issue Jan 4, 2021 · 0 comments
Closed

Inconsistent labelling of "mgmt_only" flag #5569

candlerb opened this issue Jan 4, 2021 · 0 comments
Assignees
Labels
status: accepted This issue has been accepted for implementation type: housekeeping Changes to the application which do not directly impact the end user

Comments

@candlerb
Copy link
Contributor

candlerb commented Jan 4, 2021

Environment

  • Python version: 3.6.9
  • NetBox version: 2.10.2

Steps to Reproduce

  • Go to Devices > (some device) > Add Components > Interfaces
    • Goes to /dcim/interfaces/add/?device=NN&return_url=/dcim/devices/NN/interfaces/
    • Checkbox is labelled "Management only"
    • ("Management only" is also used in InterfaceBulkEditForm, InterfaceTemplateCreateForm, InterfaceTemplateBulkEditForm)
  • Go to Devices > (some device) and click the edit button next to any interface
    • Goes to /dcim/interfaces/MM/edit/?return_url=/dcim/devices/NN/interfaces/
    • Checkbox is labelled "OOB Management"
  • Go to Devices > Interfaces and click the Configure cog to include "OOB Management" in the columns displayed
    • Column is labelled "OOB Management"

Expected Behavior

Field to be consistently labelled one way or the other.

Observed Behavior

As described above, sometimes it's "Management only" and sometimes it's "OOB Management"

It's particularly weird that the "create interface" and "edit interface" forms are different.

Code which says "Management [Oo]nly":

./netbox/dcim/tables/devicetypes.py:        verbose_name='Management Only'
./netbox/dcim/models/device_component_templates.py:        verbose_name='Management only'
./netbox/dcim/forms.py:        label='Management only'
./netbox/dcim/forms.py:        label='Management only'
./netbox/dcim/forms.py:        label='Management only',
./netbox/dcim/forms.py:        label='Management only'

Code which says "OOB Management" includes the model itself:

./netbox/dcim/migrations/0001_initial.py:                ('mgmt_only', models.BooleanField(default=False, help_text=b'This interface is used only for out-of-band management', verbose_name=b'OOB Management')),
./netbox/dcim/migrations/0037_unicode_literals.py:            field=models.BooleanField(default=False, help_text='This interface is used only for out-of-band management', verbose_name='OOB Management'),
./netbox/dcim/models/device_components.py:        verbose_name='OOB Management',

The documentation uses both phrases "management-only" and "out-of-band management":

./docs/models/dcim/interfacetemplate.md:A template for a network interface that will be created on all instantiations of the parent device type. Each interface may be assigned a physical or virtual type, and may be designated as "management-only."
./docs/models/dcim/interface.md:Interfaces in NetBox represent network interfaces used to exchange data with connected devices. On modern networks, these are most commonly Ethernet, but other types are supported as well. Each interface must be assigned a type, and may optionally be assigned a MAC address, MTU, and IEEE 802.1Q mode (tagged or access). Each interface can also be enabled or disabled, and optionally designated as management-only (for out-of-band management).
@DanSheps DanSheps added status: needs owner This issue is tentatively accepted pending a volunteer committed to its implementation type: housekeeping Changes to the application which do not directly impact the end user labels Jan 5, 2021
@jeremystretch jeremystretch added status: accepted This issue has been accepted for implementation and removed status: needs owner This issue is tentatively accepted pending a volunteer committed to its implementation labels Jan 5, 2021
@jeremystretch jeremystretch self-assigned this Jan 5, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 6, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
status: accepted This issue has been accepted for implementation type: housekeeping Changes to the application which do not directly impact the end user
Projects
None yet
Development

No branches or pull requests

3 participants