nautobot 2.3.16__py3-none-any.whl → 2.4.0b1__py3-none-any.whl

nautobot/project-static/docs/code-reference/nautobot/apps/api.html

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.49">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.46">
     
     
       
@@ -3944,6 +3944,27 @@
 
               
             
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../../user-guide/core-data-model/dcim/virtualdevicecontext.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Virtual Device Context
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
       
@@ -4556,6 +4577,123 @@
 
               
             
+              
+                
+  
+  
+  
+  
+    
+    
+    
+      
+      
+    
+    
+    <li class="md-nav__item md-nav__item--nested">
+      
+        
+        
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_3_9" >
+        
+          
+          
+          <div class="md-nav__link md-nav__container">
+            <a href="../../../user-guide/core-data-model/wireless/index.html" class="md-nav__link ">
+              
+  
+  <span class="md-ellipsis">
+    Wireless
+  </span>
+  
+
+            </a>
+            
+              
+              <label class="md-nav__link " for="__nav_2_3_9" id="__nav_2_3_9_label" tabindex="0">
+                <span class="md-nav__icon md-icon"></span>
+              </label>
+            
+          </div>
+        
+        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_3_9_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_3_9">
+            <span class="md-nav__icon md-icon"></span>
+            Wireless
+          </label>
+          <ul class="md-nav__list" data-md-scrollfix>
+            
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../../user-guide/core-data-model/wireless/supporteddatarate.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Supported Data Rate
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../../user-guide/core-data-model/wireless/radioprofile.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Radio Profile
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../../user-guide/core-data-model/wireless/wirelessnetwork.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Wireless Network
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+          </ul>
+        </nav>
+      
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
       
@@ -4767,6 +4905,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../user-guide/platform-functionality/events.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Event Notifications
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../../user-guide/platform-functionality/exporttemplate.html" class="md-nav__link">
         
@@ -4841,7 +5000,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_9" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_10" >
         
           
           
@@ -4857,14 +5016,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_2_4_9" id="__nav_2_4_9_label" tabindex="0">
+              <label class="md-nav__link " for="__nav_2_4_10" id="__nav_2_4_10_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_9_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_4_9">
+        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_10_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_4_10">
             <span class="md-nav__icon md-icon"></span>
             GraphQL
           </label>
@@ -4937,7 +5096,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_11" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_12" >
         
           
           
@@ -4953,14 +5112,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_2_4_11" id="__nav_2_4_11_label" tabindex="0">
+              <label class="md-nav__link " for="__nav_2_4_12" id="__nav_2_4_12_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_11_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_4_11">
+        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_12_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_4_12">
             <span class="md-nav__icon md-icon"></span>
             Jobs
           </label>
@@ -5035,6 +5194,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../user-guide/platform-functionality/jobs/jobqueue.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Job Queues
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../../user-guide/platform-functionality/jobs/job-scheduling-and-approvals.html" class="md-nav__link">
         
@@ -5148,6 +5328,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../user-guide/platform-functionality/rendering-jinja-templates.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Rendering Jinja Templates
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     
     
     
@@ -5159,7 +5360,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_16" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_18" >
         
           
           
@@ -5175,14 +5376,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_2_4_16" id="__nav_2_4_16_label" tabindex="0">
+              <label class="md-nav__link " for="__nav_2_4_18" id="__nav_2_4_18_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_16_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_4_16">
+        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_18_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_4_18">
             <span class="md-nav__icon md-icon"></span>
             REST API
           </label>
@@ -5402,10 +5603,10 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_23" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_25" >
         
           
-          <label class="md-nav__link" for="__nav_2_4_23" id="__nav_2_4_23_label" tabindex="0">
+          <label class="md-nav__link" for="__nav_2_4_25" id="__nav_2_4_25_label" tabindex="0">
             
   
   <span class="md-ellipsis">
@@ -5416,8 +5617,8 @@
             <span class="md-nav__icon md-icon"></span>
           </label>
         
-        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_23_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_4_23">
+        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_25_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_4_25">
             <span class="md-nav__icon md-icon"></span>
             Users
           </label>
@@ -6822,15 +7023,6 @@
     </span>
   </a>
   
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#nautobot.apps.api.BaseModelSerializer.determine_view_options" class="md-nav__link">
-    <span class="md-ellipsis">
-      determine_view_options
-    </span>
-  </a>
-  
 </li>
         
           <li class="md-nav__item">
@@ -6840,15 +7032,6 @@
     </span>
   </a>
   
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#nautobot.apps.api.BaseModelSerializer.get_additional_detail_view_tabs" class="md-nav__link">
-    <span class="md-ellipsis">
-      get_additional_detail_view_tabs
-    </span>
-  </a>
-  
 </li>
         
           <li class="md-nav__item">
@@ -6941,15 +7124,6 @@
     </span>
   </a>
   
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#nautobot.apps.api.GetObjectCountsView" class="md-nav__link">
-    <span class="md-ellipsis">
-      GetObjectCountsView
-    </span>
-  </a>
-  
 </li>
       
         <li class="md-nav__item">
@@ -7741,6 +7915,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="events.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    nautobot.apps.events
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="exceptions.html" class="md-nav__link">
         
@@ -8289,6 +8484,123 @@
 
               
             
+              
+                
+  
+  
+  
+  
+    
+    
+    
+      
+      
+    
+    
+    <li class="md-nav__item md-nav__item--nested">
+      
+        
+        
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2_9_5" >
+        
+          
+          
+          <div class="md-nav__link md-nav__container">
+            <a href="../../../development/apps/migration/ui-component-framework/index.html" class="md-nav__link ">
+              
+  
+  <span class="md-ellipsis">
+    UI Component Framework
+  </span>
+  
+
+            </a>
+            
+              
+              <label class="md-nav__link " for="__nav_3_2_9_5" id="__nav_3_2_9_5_label" tabindex="0">
+                <span class="md-nav__icon md-icon"></span>
+              </label>
+            
+          </div>
+        
+        <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_3_2_9_5_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_3_2_9_5">
+            <span class="md-nav__icon md-icon"></span>
+            UI Component Framework
+          </label>
+          <ul class="md-nav__list" data-md-scrollfix>
+            
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../../development/apps/migration/ui-component-framework/migration-steps.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Migration steps
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../../development/apps/migration/ui-component-framework/custom-content.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Custom content
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../../development/apps/migration/ui-component-framework/best-practices.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Best practices
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+          </ul>
+        </nav>
+      
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
       
@@ -8634,6 +8946,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../development/core/local-k8s.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Local Kubernetes Cluster
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../../development/core/model-checklist.html" class="md-nav__link">
         
@@ -8823,6 +9156,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../development/core/ui-component-framework.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    UI Component Framework
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../../development/core/release-checklist.html" class="md-nav__link">
         
@@ -8905,6 +9259,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../release-notes/version-2.4.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Version 2.4
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../../release-notes/version-2.3.html" class="md-nav__link">
         
@@ -9563,15 +9938,6 @@
     </span>
   </a>
   
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#nautobot.apps.api.BaseModelSerializer.determine_view_options" class="md-nav__link">
-    <span class="md-ellipsis">
-      determine_view_options
-    </span>
-  </a>
-  
 </li>
         
           <li class="md-nav__item">
@@ -9581,15 +9947,6 @@
     </span>
   </a>
   
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#nautobot.apps.api.BaseModelSerializer.get_additional_detail_view_tabs" class="md-nav__link">
-    <span class="md-ellipsis">
-      get_additional_detail_view_tabs
-    </span>
-  </a>
-  
 </li>
         
           <li class="md-nav__item">
@@ -9682,15 +10039,6 @@
     </span>
   </a>
   
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#nautobot.apps.api.GetObjectCountsView" class="md-nav__link">
-    <span class="md-ellipsis">
-      GetObjectCountsView
-    </span>
-  </a>
-  
 </li>
       
         <li class="md-nav__item">
@@ -10598,23 +10946,6 @@ which is necessary to be able to export appropriately structured CSV from a Job
 <div class="doc doc-object doc-function">
 
 
-<h3 id="nautobot.apps.api.BaseModelSerializer.determine_view_options" class="doc doc-heading">
-            <code class="highlight language-python"><span class="n">determine_view_options</span><span class="p">(</span><span class="n">request</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span></code>
-
-<a href="#nautobot.apps.api.BaseModelSerializer.determine_view_options" class="headerlink" title="Permanent link">&para;</a></h3>
-
-
-    <div class="doc doc-contents ">
-
-      <p>Determine view options to use for rendering the list and detail views associated with this serializer.</p>
-
-    </div>
-
-</div>
-
-<div class="doc doc-object doc-function">
-
-
 <h3 id="nautobot.apps.api.BaseModelSerializer.extend_field_names" class="doc doc-heading">
             <code class="highlight language-python"><span class="n">extend_field_names</span><span class="p">(</span><span class="n">fields</span><span class="p">,</span> <span class="n">field_name</span><span class="p">,</span> <span class="n">at_start</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">opt_in_only</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></code>
 
@@ -10632,48 +10963,6 @@ which is necessary to be able to export appropriately structured CSV from a Job
 <div class="doc doc-object doc-function">
 
 
-<h3 id="nautobot.apps.api.BaseModelSerializer.get_additional_detail_view_tabs" class="doc doc-heading">
-            <code class="highlight language-python"><span class="n">get_additional_detail_view_tabs</span><span class="p">()</span></code>
-
-<a href="#nautobot.apps.api.BaseModelSerializer.get_additional_detail_view_tabs" class="headerlink" title="Permanent link">&para;</a></h3>
-
-
-    <div class="doc doc-contents ">
-
-      <p>Retrieve definitions of non-default detail view tabs.</p>
-<p>By default provides an "Advanced" tab containing <code>self.advanced_tab_fields</code>, but subclasses
-can override this to move additional serializer fields to this or other tabs.</p>
-
-
-    <p><span class="doc-section-title">Returns:</span></p>
-    <table>
-      <thead>
-        <tr>
-          <th>Type</th>
-          <th>Description</th>
-        </tr>
-      </thead>
-      <tbody>
-          <tr class="doc-section-item">
-            <td>
-                  <code><autoref identifier="dict" optional>dict</autoref></code>
-            </td>
-            <td>
-              <div class="doc-md-description">
-                <p><code>{&lt;tab label&gt;: [{&lt;panel label&gt;: {"fields": [&lt;list of fields&gt;]}, ...}, ...], ...}</code></p>
-              </div>
-            </td>
-          </tr>
-      </tbody>
-    </table>
-
-    </div>
-
-</div>
-
-<div class="doc doc-object doc-function">
-
-
 <h3 id="nautobot.apps.api.BaseModelSerializer.get_display" class="doc doc-heading">
             <code class="highlight language-python"><span class="n">get_display</span><span class="p">(</span><span class="n">instance</span><span class="p">)</span></code>
 
@@ -10980,46 +11269,6 @@ For example:</p>
 
 
 
-  </div>
-
-    </div>
-
-</div>
-
-<div class="doc doc-object doc-class">
-
-
-
-<h2 id="nautobot.apps.api.GetObjectCountsView" class="doc doc-heading">
-            <code>nautobot.apps.api.GetObjectCountsView</code>
-
-
-<a href="#nautobot.apps.api.GetObjectCountsView" class="headerlink" title="Permanent link">&para;</a></h2>
-
-
-    <div class="doc doc-contents ">
-            <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="nautobot.core.api.views.NautobotAPIVersionMixin" optional hover>NautobotAPIVersionMixin</autoref></code>, <code><autoref identifier="rest_framework.views.APIView" optional hover>APIView</autoref></code></p>
-
-
-      <p>Enumerate the models listed on the Nautobot home page and return data structure
-containing verbose_name_plural, url and count.</p>
-
-
-
-
-  <div class="doc doc-children">
-
-
-
-
-
-
-
-
-
-
-
   </div>
 
     </div>
@@ -12982,10 +13231,10 @@ data any serializer fields that do not correspond to a specific model field</p>
     </div>
     
     
-    <script id="__config" type="application/json">{"base": "../../..", "features": ["content.code.copy", "content.tabs.link", "navigation.footer", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.highlight", "search.share", "search.suggest"], "search": "../../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
+    <script id="__config" type="application/json">{"base": "../../..", "features": ["content.code.annotate", "content.code.copy", "content.tabs.link", "navigation.footer", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.highlight", "search.share", "search.suggest"], "search": "../../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.88dd0f4e.min.js"></script>
+      <script src="../../../assets/javascripts/bundle.83f73b43.min.js"></script>
       
         <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>