#5401: Add custom field support for VMInterface

Author: jeremystretch

netbox/templates/virtualization/vminterface.html

@@ -57,9 +57,10 @@
                 </tr>
             </table>
         </div>
-          {% plugin_left_page object %}
+        {% plugin_left_page object %}
     </div>
     <div class="col-md-6">
+        {% include 'inc/custom_fields_panel.html' %}
         {% include 'extras/inc/tags_panel.html' with tags=object.tags.all %}
           {% plugin_right_page object %}
     </div>

netbox/templates/virtualization/vminterface_edit.html

@@ -31,6 +31,14 @@
             {% render_field form.tagged_vlans %}
         </div>
     </div>
+    {% if form.custom_fields %}
+      <div class="panel panel-default">
+        <div class="panel-heading"><strong>Custom Fields</strong></div>
+        <div class="panel-body">
+          {% render_custom_fields form %}
+        </div>
+      </div>
+    {% endif %}
 {% endblock %}
 
 {% block buttons %}

netbox/virtualization/api/serializers.py

@@ -103,7 +103,7 @@ def get_config_context(self, obj):
 # VM interfaces
 #
 
-class VMInterfaceSerializer(TaggedObjectSerializer, ValidatedModelSerializer):
+class VMInterfaceSerializer(TaggedObjectSerializer, CustomFieldModelSerializer):
     url = serializers.HyperlinkedIdentityField(view_name='virtualization-api:vminterface-detail')
     virtual_machine = NestedVirtualMachineSerializer()
     mode = ChoiceField(choices=InterfaceModeChoices, allow_blank=True, required=False)
@@ -119,7 +119,7 @@ class Meta:
         model = VMInterface
         fields = [
             'id', 'url', 'virtual_machine', 'name', 'enabled', 'mtu', 'mac_address', 'description', 'mode',
-            'untagged_vlan', 'tagged_vlans', 'tags',
+            'untagged_vlan', 'tagged_vlans', 'tags', 'custom_fields', 'created', 'last_updated',
         ]
 
     def validate(self, data):

netbox/virtualization/filters.py

@@ -237,7 +237,7 @@ def _has_primary_ip(self, queryset, name, value):
         return queryset.exclude(params)
 
 
-class VMInterfaceFilterSet(BaseFilterSet):
+class VMInterfaceFilterSet(BaseFilterSet, CustomFieldModelFilterSet, CreatedUpdatedFilterSet):
     q = django_filters.CharFilter(
         method='search',
         label='Search',

netbox/virtualization/forms.py

@@ -576,7 +576,7 @@ class VirtualMachineFilterForm(BootstrapMixin, TenancyFilterForm, CustomFieldFil
 # VM interfaces
 #
 
-class VMInterfaceForm(BootstrapMixin, InterfaceCommonForm, forms.ModelForm):
+class VMInterfaceForm(BootstrapMixin, InterfaceCommonForm, CustomFieldModelForm):
     untagged_vlan = DynamicModelChoiceField(
         queryset=VLAN.objects.all(),
         required=False,

netbox/virtualization/migrations/0020_standardize_models.py

@@ -54,4 +54,9 @@ class Migration(migrations.Migration):
             name='last_updated',
             field=models.DateTimeField(auto_now=True, null=True),
         ),
+        migrations.AddField(
+            model_name='vminterface',
+            name='custom_field_data',
+            field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder),
+        ),
     ]

netbox/virtualization/models.py

@@ -9,7 +9,7 @@
 from extras.models import ConfigContextModel, TaggedItem
 from extras.querysets import ConfigContextModelQuerySet
 from extras.utils import extras_features
-from netbox.models import ChangeLoggedModel, OrganizationalModel, PrimaryModel
+from netbox.models import OrganizationalModel, PrimaryModel
 from utilities.fields import NaturalOrderingField
 from utilities.ordering import naturalize_interface
 from utilities.query_functions import CollateAsChar
@@ -372,9 +372,8 @@ def site(self):
 # Interfaces
 #
 
-# TODO: Inherit from PrimaryModel
-@extras_features('export_templates', 'webhooks')
-class VMInterface(ChangeLoggedModel, BaseInterface):
+@extras_features('custom_fields', 'custom_links', 'export_templates', 'webhooks')
+class VMInterface(PrimaryModel, BaseInterface):
     virtual_machine = models.ForeignKey(
         to='virtualization.VirtualMachine',
         on_delete=models.CASCADE,