Add device_id and virtual_machine_id to ipam.forms.filtersets.ServiceFilterForm

[atownson]

NetBox version

v3.5.7

Feature type

Change to existing functionality

Proposed functionality

I propose to add fields device_id and virtual_machine_id to the ServiceFilterForm class. Currently there's no way to filter a service by the associated device or virtual machine in the web form. The search method also does not include these fields.

The API does support filtering by device and virtual machine.

This feature request can be accomplished by updating the filtersets.py from:

class ServiceFilterForm(ServiceTemplateFilterForm):
    model = Service
    tag = TagFilterField(model)

to:

class ServiceFilterForm(ServiceTemplateFilterForm):
    model = Service
    fieldsets = (
        (None, ('q', 'filter_id', 'tag')),
        (_('Attributes'), ('protocol', 'port')),
        (_('Device/VM'), ('device_id', 'virtual_machine_id')),
    )
    device_id = DynamicModelMultipleChoiceField(
        queryset=Device.objects.all(),
        required=False,
        label=_('Assigned Device'),
    )
    virtual_machine_id = DynamicModelMultipleChoiceField(
        queryset=VirtualMachine.objects.all(),
        required=False,
        label=_('Assigned VM'),
    )

Result:

I could handle this PR if desired and if this request is approved.

Use case

Adding these fields would improve the user experience, align the services model filterset with the IP address model filterset, and provide functionality available in the API to the web filter forms.

Database changes

None

External dependencies

None

[atownson]

Another option for this would be to modify the string definition of the Service model to include the device/vm:

def __str__(self):
    return f'{self.device or self.virtual_machine} -> {self.name} ({self.get_protocol_display()}/{self.port_list})'

This could obviously get rather lengthy and verbose, depending on the Service properties, but one example might be:

vm01splunk -> Splunk Web (TCP/8000)

This would need to be searchable too.

[jeremystretch]

The API does support filtering by device and virtual machine.

This is incorrect. ServiceFilterSet supports filtering by both device and VM by ID or name. The scope of this FR would be limited to adding these fields to the filter form.