Fixes #2365: Toggle for showing available prefixes/ip addresses

docs/release-notes/version-2.6.md

@@ -2,6 +2,7 @@
 
 ## Enhancements
 
+* [#2365](https://github.com/netbox-community/netbox/issues/2365) - Toggle for showing available prefixes/ip addresses
 * [#3705](https://github.com/netbox-community/netbox/issues/3705) - Provide request context when executing custom scripts
 * [#3762](https://github.com/netbox-community/netbox/issues/3762) - Add date/time picker widgets
 * [#3788](https://github.com/netbox-community/netbox/issues/3788) - Enable partial search for inventory items

netbox/ipam/views.py

@@ -333,7 +333,14 @@ class AggregateView(PermissionRequiredMixin, View):
         ).annotate_depth(
             limit=0
         )
-        child_prefixes = add_available_prefixes(aggregate.prefix, child_prefixes)
+
+        # Update the ipam_show_available cookie if request specifies it
+        if request.GET.get('show_available') is not None:
+            request.session['ipam_show_available'] = request.GET.get('show_available') == 'true'
+
+        # Add available prefixes to the table if the cookie requested it
+        if request.session.get('ipam_show_available'):
+            child_prefixes = add_available_prefixes(aggregate.prefix, child_prefixes)
 
         prefix_table = tables.PrefixDetailTable(child_prefixes)
         if request.user.has_perm('ipam.change_prefix') or request.user.has_perm('ipam.delete_prefix'):
@@ -356,6 +363,7 @@ class AggregateView(PermissionRequiredMixin, View):
             'aggregate': aggregate,
             'prefix_table': prefix_table,
             'permissions': permissions,
+            'show_available': request.session.get('ipam_show_available'),
         })
 
 
@@ -511,8 +519,12 @@ class PrefixPrefixesView(PermissionRequiredMixin, View):
             'site', 'vlan', 'role',
         ).annotate_depth(limit=0)
 
-        # Annotate available prefixes
-        if child_prefixes:
+        # Update the ipam_show_available cookie if request specifies it
+        if request.GET.get('show_available') is not None:
+            request.session['ipam_show_available'] = request.GET.get('show_available') == 'true'
+
+        # Add available prefixes to the table if the cookie requested it
+        if child_prefixes and request.session.get('ipam_show_available'):
             child_prefixes = add_available_prefixes(prefix.prefix, child_prefixes)
 
         prefix_table = tables.PrefixDetailTable(child_prefixes)
@@ -539,6 +551,7 @@ class PrefixPrefixesView(PermissionRequiredMixin, View):
             'permissions': permissions,
             'bulk_querystring': 'vrf_id={}&within={}'.format(prefix.vrf.pk if prefix.vrf else '0', prefix.prefix),
             'active_tab': 'prefixes',
+            'show_available': request.session.get('ipam_show_available'),
         })
 
 
@@ -553,7 +566,14 @@ class PrefixIPAddressesView(PermissionRequiredMixin, View):
         ipaddresses = prefix.get_child_ips().prefetch_related(
             'vrf', 'interface__device', 'primary_ip4_for', 'primary_ip6_for'
         )
-        ipaddresses = add_available_ipaddresses(prefix.prefix, ipaddresses, prefix.is_pool)
+
+        # Update the ipam_show_available cookie if request specifies it
+        if request.GET.get('show_available') is not None:
+            request.session['ipam_show_available'] = request.GET.get('show_available') == 'true'
+
+        # Add available IP addresses to the table if the cookie requested it
+        if request.session.get('ipam_show_available'):
+            ipaddresses = add_available_ipaddresses(prefix.prefix, ipaddresses, prefix.is_pool)
 
         ip_table = tables.IPAddressTable(ipaddresses)
         if request.user.has_perm('ipam.change_ipaddress') or request.user.has_perm('ipam.delete_ipaddress'):
@@ -579,6 +599,7 @@ class PrefixIPAddressesView(PermissionRequiredMixin, View):
             'permissions': permissions,
             'bulk_querystring': 'vrf_id={}&parent={}'.format(prefix.vrf.pk if prefix.vrf else '0', prefix.prefix),
             'active_tab': 'ip-addresses',
+            'show_available': request.session.get('ipam_show_available'),
         })
 
 

netbox/templates/ipam/aggregate.html

@@ -40,6 +40,14 @@
     </div>
     <h1>{% block title %}{{ aggregate }}{% endblock %}</h1>
     {% include 'inc/created_updated.html' with obj=aggregate %}
+    {% if show_available is not None %}
+        <div class="pull-right">
+            <div class="btn-group" role="group">
+                <a href="{{ request.path }}{% querystring request show_available='true' %}" class="btn btn-default{% if show_available %} active disabled{% endif %}">Show available</a>
+                <a href="{{ request.path }}{% querystring request show_available='false' %}" class="btn btn-default{% if not show_available %} active disabled{% endif %}">Hide available</a>
+            </div>
+        </div>
+    {% endif %}
     <div class="pull-right noprint">
         {% custom_links aggregate %}
     </div>

netbox/templates/ipam/prefix.html

@@ -53,6 +53,14 @@
     </div>
     <h1>{% block title %}{{ prefix }}{% endblock %}</h1>
     {% include 'inc/created_updated.html' with obj=prefix %}
+    {% if show_available is not None %}
+        <div class="pull-right">
+            <div class="btn-group" role="group">
+                <a href="{{ request.path }}{% querystring request show_available='true' %}" class="btn btn-default{% if show_available %} active disabled{% endif %}">Show available</a>
+                <a href="{{ request.path }}{% querystring request show_available='false' %}" class="btn btn-default{% if not show_available %} active disabled{% endif %}">Hide available</a>
+            </div>
+        </div>
+    {% endif %}
     <div class="pull-right noprint">
         {% custom_links prefix %}
     </div>