nautobot 3.0.4__py3-none-any.whl → 3.0.5__py3-none-any.whl

nautobot/project-static/docs/user-guide/platform-functionality/rest-api/filtering.html

@@ -974,6 +974,34 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../administration/upgrading/postgresql.html" class="md-nav__link">
+        
+  
+  
+  <span class="md-ellipsis">
+    
+  
+    Upgrading PostgreSQL
+  
+
+    
+  </span>
+  
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../administration/upgrading/upgrading.html" class="md-nav__link">
         
@@ -1014,7 +1042,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_2_3">
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_2_4">
         
           
           <div class="md-nav__link md-nav__container">
@@ -1036,14 +1064,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_2_1_2_3" id="__nav_2_1_2_3_label" tabindex="0">
+              <label class="md-nav__link " for="__nav_2_1_2_4" id="__nav_2_1_2_4_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_2_1_2_3_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_1_2_3">
+        <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_2_1_2_4_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_1_2_4">
             <span class="md-nav__icon md-icon"></span>
             
   
@@ -1099,7 +1127,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_2_3_2">
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_2_4_2">
         
           
           <div class="md-nav__link md-nav__container">
@@ -1121,14 +1149,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_2_1_2_3_2" id="__nav_2_1_2_3_2_label" tabindex="0">
+              <label class="md-nav__link " for="__nav_2_1_2_4_2" id="__nav_2_1_2_4_2_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="5" aria-labelledby="__nav_2_1_2_3_2_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_1_2_3_2">
+        <nav class="md-nav" data-md-level="5" aria-labelledby="__nav_2_1_2_4_2_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_1_2_4_2">
             <span class="md-nav__icon md-icon"></span>
             
   
@@ -7878,10 +7906,10 @@
 </li>
         
           <li class="md-nav__item">
-  <a href="#network-and-host-fields" class="md-nav__link">
+  <a href="#ipam-custom-filters" class="md-nav__link">
     <span class="md-ellipsis">
       
-        Network and Host Fields
+        IPAM Custom Filters
       
     </span>
   </a>
@@ -9091,6 +9119,34 @@
 
               
             
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../../development/apps/api/models/queryset.html" class="md-nav__link">
+        
+  
+  
+  <span class="md-ellipsis">
+    
+  
+    QuerySet
+  
+
+    
+  </span>
+  
+  
+
+      </a>
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
       
@@ -13297,10 +13353,10 @@
 </li>
         
           <li class="md-nav__item">
-  <a href="#network-and-host-fields" class="md-nav__link">
+  <a href="#ipam-custom-filters" class="md-nav__link">
     <span class="md-ellipsis">
       
-        Network and Host Fields
+        IPAM Custom Filters
       
     </span>
   </a>
@@ -13456,30 +13512,56 @@
 <details class="version-added">
 <summary>Added in version 2.1.0 — Added <code>__isnull</code> lookup expression</summary>
 </details>
-<h3 id="network-and-host-fields">Network and Host Fields<a class="headerlink" href="#network-and-host-fields" title="Permanent link">¶</a></h3>
-<p>There are <a href="https://docs.djangoproject.com/en/3.2/howto/custom-lookups/">Custom Lookups</a> built for the <code>VarbinaryIPField</code> field types. While the <code>VarbinaryIPField</code> is applied to fields for <code>network</code>, <code>host</code>, and <code>broadcast</code>, the below filters only apply to <code>network</code> and <code>host</code>. The design makes an assumption that there is in fact a <code>broadcast</code> (of type <code>VarbinaryIPField</code>) and <code>prefix_length</code> (of type <code>Integer</code>) within the same model. This assumption is used to understand the relevant scope of the network in question and is important to note when extending the Nautobot core or App data model.</p>
+<h3 id="ipam-custom-filters">IPAM Custom Filters<a class="headerlink" href="#ipam-custom-filters" title="Permanent link">¶</a></h3>
+<p>IPAM Custom Filters are related to the lookups defined in <a href="../../../development/apps/api/models/queryset.html#ipam-custom-lookups">Queryset Docs</a>. These lookups are mapped to the filters on Prefix's with minor modifications such as accounting for bad networks or stripping whitespace.</p>
+<table>
+<thead>
+<tr>
+<th>Filter Name</th>
+<th>Lookup</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><code>address</code> (IP)</td>
+<td><code>net_in</code></td>
+</tr>
+<tr>
+<td><code>prefix</code></td>
+<td><code>net_equals()</code></td>
+</tr>
+<tr>
+<td><code>prefix_exact</code></td>
+<td><code>net_equals()</code></td>
+</tr>
+<tr>
+<td><code>within</code></td>
+<td><code>net_contained()</code></td>
+</tr>
+<tr>
+<td><code>within_include</code></td>
+<td><code>net_contained_or_equal()</code></td>
+</tr>
+<tr>
+<td><code>contains</code> (CIDR input)</td>
+<td><code>net_contains_or_equals()</code></td>
+</tr>
+<tr>
+<td><code>contains</code> (host input)</td>
+<td>Custom logic for host input</td>
+</tr>
+</tbody>
+</table>
+<div class="admonition tip">
+<p class="admonition-title">Tip</p>
+<p>The <code>prefix</code> matches does not consider where host bits are set, matching how <code>netaddr</code>, <code>ipaddress</code>, and many popular subnet calculators do. If you want to consider the host bits, you should use <code>prefix_exact</code>.</p>
+<p>For example:</p>
 <ul>
-<li><code>**</code> <code>exact</code> - An exact match of an IP or network address, e.g. <code>host__exact="10.0.0.1"</code></li>
-<li><code>**</code> <code>iexact</code> - An exact match of an IP or network address, e.g. <code>host__iexact="10.0.0.1"</code></li>
-<li><code>**</code> <code>startswith</code> - Determine if IP or network starts with the value provided, e.g. <code>host__startswith="10.0.0."</code></li>
-<li><code>**</code> <code>istartswith</code> - Determine if IP or network starts with the value provided, e.g. <code>host__istartswith="10.0.0."</code></li>
-<li><code>**</code> <code>endswith</code> - Determine if IP or network ends with the value provided, e.g. <code>host__endswith="0.1"</code></li>
-<li><code>**</code> <code>iendswith</code> - Determine if IP or network ends with the value provided, e.g. <code>host__iendswith="0.1"</code></li>
-<li><code>**</code> <code>regex</code> - Determine if IP or network matches the pattern provided, e.g. <code>host__regex=r"10\.(.*)\.1</code></li>
-<li><code>**</code> <code>iregex</code> - Determine if IP or network matches the pattern provided, e.g. <code>host__iregex=r"10\.(.*)\.1</code></li>
-<li><code>net_contained</code> - Given a network, determine which networks are contained within the provided e.g. <code>network__net_contained="192.0.0.0/8"</code> would include 192.168.0.0/24 in the result</li>
-<li><code>net_contained_or_equal</code> - Given a network, determine which networks are contained or is within the provided e.g. <code>network__net_contained_or_equal="192.0.0.0/8"</code> would include 192.168.0.0/24 and 192.0.0.0/8 in the result</li>
-<li><code>net_contains</code> - Given a network, determine which networks contain the provided network e.g. <code>network__net_contains="192.168.0.0/16"</code> would include 192.0.0.0/8 in the result</li>
-<li><code>net_contains_or_equals</code> - Given a network, determine which networks contain or is the provided network e.g. <code>network__net_contains="192.168.0.0/16"</code> would include 192.0.0.0/8 and 192.168.0.0/16 in the result</li>
-<li><code>net_equals</code> - Given a network, determine which which networks are an exact match. e.g. <code>network__net_equals="192.168.0.0/16"</code> would include only 192.168.0.0/16 in the result</li>
-<li><code>net_host</code> - Determine which networks are parent of the provided IP, e.g. <code>host__net_host="10.0.0.1"</code> would include 10.0.0.1/32 and 10.0.0.0/24 in the result</li>
-<li><code>net_host_contained</code> - Given a network, select IPs whose host address (regardless of its subnet mask) falls within that network , e.g. <code>host__net_host_contained="10.0.0.0/24"</code> would include hosts 10.0.0.1/8 and 10.0.0.254/32 in the result</li>
-<li><code>net_in</code> - Given a list of networks, select addresses (regardless of their subnet masks) within those networks, e.g. <code>host__net_in=["10.0.0.0/24", "2001:db8::/64"]</code> would include hosts 10.0.0.1/16 and 2001:db8::1/65 in the result</li>
-<li><code>family</code> - Given an IP address family of 4 or 6, provide hosts or networks that are that IP version type, e.g. <code>host__family=6</code> would include 2001:db8::1 in the result</li>
+<li><code>prefix=10.32.0.34/28</code> <strong>matches</strong> <code>10.32.0.32/28</code></li>
+<li><code>prefix_exact=10.32.0.34/28</code> <strong>returns an error</strong></li>
 </ul>
-<blockquote>
-<p>Note: The fields denoted with <code>**</code> are only supported in the MySQL dialect (and not Postgresql) at the current time.</p>
-</blockquote>
+<p>This is useful when consumers need strict, unambiguous matching and want to avoid implicit normalization by the filtering layer.</p>
+</div>
 
 
 

nautobot/project-static/docs/user-guide/platform-functionality/rest-api/overview.html

@@ -974,6 +974,34 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../administration/upgrading/postgresql.html" class="md-nav__link">
+        
+  
+  
+  <span class="md-ellipsis">
+    
+  
+    Upgrading PostgreSQL
+  
+
+    
+  </span>
+  
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../administration/upgrading/upgrading.html" class="md-nav__link">
         
@@ -1014,7 +1042,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_2_3">
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_2_4">
         
           
           <div class="md-nav__link md-nav__container">
@@ -1036,14 +1064,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_2_1_2_3" id="__nav_2_1_2_3_label" tabindex="0">
+              <label class="md-nav__link " for="__nav_2_1_2_4" id="__nav_2_1_2_4_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_2_1_2_3_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_1_2_3">
+        <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_2_1_2_4_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_1_2_4">
             <span class="md-nav__icon md-icon"></span>
             
   
@@ -1099,7 +1127,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_2_3_2">
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_2_4_2">
         
           
           <div class="md-nav__link md-nav__container">
@@ -1121,14 +1149,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_2_1_2_3_2" id="__nav_2_1_2_3_2_label" tabindex="0">
+              <label class="md-nav__link " for="__nav_2_1_2_4_2" id="__nav_2_1_2_4_2_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="5" aria-labelledby="__nav_2_1_2_3_2_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_1_2_3_2">
+        <nav class="md-nav" data-md-level="5" aria-labelledby="__nav_2_1_2_4_2_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_1_2_4_2">
             <span class="md-nav__icon md-icon"></span>
             
   
@@ -8922,6 +8950,34 @@
 
               
             
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../../development/apps/api/models/queryset.html" class="md-nav__link">
+        
+  
+  
+  <span class="md-ellipsis">
+    
+  
+    QuerySet
+  
+
+    
+  </span>
+  
+  
+
+      </a>
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
       

nautobot/project-static/docs/user-guide/platform-functionality/rest-api/ui-related-endpoints.html

@@ -974,6 +974,34 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../administration/upgrading/postgresql.html" class="md-nav__link">
+        
+  
+  
+  <span class="md-ellipsis">
+    
+  
+    Upgrading PostgreSQL
+  
+
+    
+  </span>
+  
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../administration/upgrading/upgrading.html" class="md-nav__link">
         
@@ -1014,7 +1042,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_2_3">
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_2_4">
         
           
           <div class="md-nav__link md-nav__container">
@@ -1036,14 +1064,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_2_1_2_3" id="__nav_2_1_2_3_label" tabindex="0">
+              <label class="md-nav__link " for="__nav_2_1_2_4" id="__nav_2_1_2_4_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_2_1_2_3_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_1_2_3">
+        <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_2_1_2_4_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_1_2_4">
             <span class="md-nav__icon md-icon"></span>
             
   
@@ -1099,7 +1127,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_2_3_2">
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_2_4_2">
         
           
           <div class="md-nav__link md-nav__container">
@@ -1121,14 +1149,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_2_1_2_3_2" id="__nav_2_1_2_3_2_label" tabindex="0">
+              <label class="md-nav__link " for="__nav_2_1_2_4_2" id="__nav_2_1_2_4_2_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="5" aria-labelledby="__nav_2_1_2_3_2_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_1_2_3_2">
+        <nav class="md-nav" data-md-level="5" aria-labelledby="__nav_2_1_2_4_2_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_1_2_4_2">
             <span class="md-nav__icon md-icon"></span>
             
   
@@ -8932,6 +8960,34 @@
 
               
             
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../../development/apps/api/models/queryset.html" class="md-nav__link">
+        
+  
+  
+  <span class="md-ellipsis">
+    
+  
+    QuerySet
+  
+
+    
+  </span>
+  
+  
+
+      </a>
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
       

nautobot/project-static/docs/user-guide/platform-functionality/role.html

@@ -974,6 +974,34 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../administration/upgrading/postgresql.html" class="md-nav__link">
+        
+  
+  
+  <span class="md-ellipsis">
+    
+  
+    Upgrading PostgreSQL
+  
+
+    
+  </span>
+  
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../administration/upgrading/upgrading.html" class="md-nav__link">
         
@@ -1014,7 +1042,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_2_3">
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_2_4">
         
           
           <div class="md-nav__link md-nav__container">
@@ -1036,14 +1064,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_2_1_2_3" id="__nav_2_1_2_3_label" tabindex="0">
+              <label class="md-nav__link " for="__nav_2_1_2_4" id="__nav_2_1_2_4_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_2_1_2_3_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_1_2_3">
+        <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_2_1_2_4_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_1_2_4">
             <span class="md-nav__icon md-icon"></span>
             
   
@@ -1099,7 +1127,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_2_3_2">
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_2_4_2">
         
           
           <div class="md-nav__link md-nav__container">
@@ -1121,14 +1149,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_2_1_2_3_2" id="__nav_2_1_2_3_2_label" tabindex="0">
+              <label class="md-nav__link " for="__nav_2_1_2_4_2" id="__nav_2_1_2_4_2_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="5" aria-labelledby="__nav_2_1_2_3_2_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_1_2_3_2">
+        <nav class="md-nav" data-md-level="5" aria-labelledby="__nav_2_1_2_4_2_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_1_2_4_2">
             <span class="md-nav__icon md-icon"></span>
             
   
@@ -8978,6 +9006,34 @@
 
               
             
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../development/apps/api/models/queryset.html" class="md-nav__link">
+        
+  
+  
+  <span class="md-ellipsis">
+    
+  
+    QuerySet
+  
+
+    
+  </span>
+  
+  
+
+      </a>
+    </li>
+  
+
+              
+            
           </ul>
         </nav>