Adds utilization on vlan groups

netbox/ipam/api/serializers.py

@@ -184,12 +184,13 @@ class VLANGroupSerializer(NetBoxModelSerializer):
     scope_id = serializers.IntegerField(allow_null=True, required=False, default=None)
     scope = serializers.SerializerMethodField(read_only=True)
     vlan_count = serializers.IntegerField(read_only=True)
+    utilization = serializers.CharField(source='get_utilization', read_only=True)
 
     class Meta:
         model = VLANGroup
         fields = [
             'id', 'url', 'display', 'name', 'slug', 'scope_type', 'scope_id', 'scope', 'min_vid', 'max_vid',
-            'description', 'tags', 'custom_fields', 'created', 'last_updated', 'vlan_count',
+            'description', 'tags', 'custom_fields', 'created', 'last_updated', 'vlan_count', 'utilization'
         ]
         validators = []
 

netbox/ipam/models/vlans.py

@@ -114,6 +114,15 @@ def get_next_available_vid(self):
             return available_vids[0]
         return None
 
+    def get_utilization(self):
+        """
+        Return the percentage of utilization for this vlan group.
+        """
+        assigned_vlan = VLAN.objects.filter(group=self.id).count()
+        if assigned_vlan != 0:
+            return round(assigned_vlan / (self.max_vid - self.min_vid + 1) * 100, 2)
+        return 0.0
+
 
 class VLAN(PrimaryModel):
     """

netbox/ipam/tables/vlans.py

@@ -70,6 +70,10 @@ class VLANGroupTable(NetBoxTable):
         url_params={'group_id': 'pk'},
         verbose_name='VLANs'
     )
+    get_utilization = columns.UtilizationColumn(
+        orderable=False,
+        verbose_name='Utilization'
+    )
     tags = columns.TagColumn(
         url_name='ipam:vlangroup_list'
     )
@@ -81,9 +85,9 @@ class Meta(NetBoxTable.Meta):
         model = VLANGroup
         fields = (
             'pk', 'id', 'name', 'scope_type', 'scope', 'min_vid', 'max_vid', 'vlan_count', 'slug', 'description',
-            'tags', 'created', 'last_updated', 'actions',
+            'tags', 'created', 'last_updated', 'actions', 'get_utilization',
         )
-        default_columns = ('pk', 'name', 'scope_type', 'scope', 'vlan_count', 'description')
+        default_columns = ('pk', 'name', 'scope_type', 'scope', 'vlan_count', 'get_utilization', 'description')
 
 
 #

netbox/templates/ipam/vlangroup.html

@@ -48,6 +48,10 @@ <h5 class="card-header">VLAN Group</h5>
               <a href="{% url 'ipam:vlan_list' %}?group_id={{ object.pk }}">{{ vlans_count }}</a>
             </td>
           </tr>
+          <tr>
+            <th scope="row">Utilization</th>
+            <td>{% utilization_graph object.get_utilization %}</td>
+          </tr>
         </table>
       </div>
     </div>