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

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

@@ -2112,6 +2112,27 @@
 
               
             
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../../user-guide/feature-guides/wireless-networks-and-controllers.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Wireless Networks and Controllers
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
       
@@ -3944,6 +3965,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 +4598,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 +4926,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 +5021,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 +5037,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 +5117,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 +5133,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>
@@ -4972,6 +5152,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../user-guide/platform-functionality/jobs/kubernetes-job-support.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Kubernetes Job Support
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../../user-guide/platform-functionality/jobs/jobbutton.html" class="md-nav__link">
         
@@ -5035,6 +5236,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 +5370,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 +5402,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 +5418,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 +5645,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 +5659,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>
@@ -6964,6 +7207,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">
         
@@ -7512,6 +7776,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>
       
@@ -7857,6 +8238,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../development/core/minikube-dev-environment-for-k8s-jobs.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Minikube Dev Environment for K8s Jobs
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../../development/core/model-checklist.html" class="md-nav__link">
         
@@ -8046,6 +8448,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">
         
@@ -8128,6 +8551,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">
         
@@ -8838,7 +9282,12 @@
 
     <div class="doc doc-contents first">
 
-      <p>Utilities for implementing choices.</p>
+        <p>Utilities for implementing choices.</p>
+
+
+
+
+
 
 
 
@@ -8864,10 +9313,15 @@
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="nautobot.core.choices.ChoiceSet" optional hover>ChoiceSet</autoref></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.choices.ChoiceSet" href="#nautobot.apps.choices.ChoiceSet">ChoiceSet</a></code></p>
+
+
+        <p>Styling choices for custom banners.</p>
+
+
+
 
 
-      <p>Styling choices for custom banners.</p>
 
 
 
@@ -8903,10 +9357,15 @@
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="nautobot.core.choices.ChoiceSet" optional hover>ChoiceSet</autoref></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.choices.ChoiceSet" href="#nautobot.apps.choices.ChoiceSet">ChoiceSet</a></code></p>
+
+
+        <p>Map standard button actions to Bootstrap color classes.</p>
+
+
+
 
 
-      <p>Map standard button actions to Bootstrap color classes.</p>
 
 
 
@@ -8942,10 +9401,15 @@
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="nautobot.core.choices.ChoiceSet" optional hover>ChoiceSet</autoref></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.choices.ChoiceSet" href="#nautobot.apps.choices.ChoiceSet">ChoiceSet</a></code></p>
+
+
+        <p>Map standard button actions to Material Design Icons classes.</p>
+
+
+
 
 
-      <p>Map standard button actions to Material Design Icons classes.</p>
 
 
 
@@ -8982,7 +9446,7 @@
     <div class="doc doc-contents ">
 
 
-      <p>Base class for defining choices for a model and/or menu.</p>
+        <p>Base class for defining choices for a model and/or menu.</p>
 <p>Subclasses should define a CHOICES constant which consists of a list of tuples of the form <code>(value, display_str)</code>,
 or optionally as tuples of the form <code>(grouping, ((value, display_str), (value, display_str), ...))</code>.</p>
 
@@ -9004,6 +9468,11 @@ or optionally as tuples of the form <code>(grouping, ((value, display_str), (val
 
 
 
+
+
+
+
+
   <div class="doc doc-children">
 
 
@@ -9029,7 +9498,7 @@ or optionally as tuples of the form <code>(grouping, ((value, display_str), (val
 
     <div class="doc doc-contents ">
 
-      <p>Get a dictionary representation of this ChoiceSet's <code>CHOICES</code>.</p>
+        <p>Get a dictionary representation of this ChoiceSet's <code>CHOICES</code>.</p>
 
     </div>
 
@@ -9050,7 +9519,7 @@ or optionally as tuples of the form <code>(grouping, ((value, display_str), (val
 
     <div class="doc doc-contents ">
 
-      <p>Get a flat list of all values defined in this ChoiceSet's <code>CHOICES</code>.</p>
+        <p>Get a flat list of all values defined in this ChoiceSet's <code>CHOICES</code>.</p>
 
     </div>
 
@@ -9077,15 +9546,20 @@ or optionally as tuples of the form <code>(grouping, ((value, display_str), (val
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="nautobot.core.choices.ChoiceSet" optional hover>ChoiceSet</autoref></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.choices.ChoiceSet" href="#nautobot.apps.choices.ChoiceSet">ChoiceSet</a></code></p>
 
 
-      <p>These status choices are using the same taxonomy as within Celery core. A Nautobot Job status
+        <p>These status choices are using the same taxonomy as within Celery core. A Nautobot Job status
 is equivalent to a Celery task state.</p>
 
 
 
 
+
+
+
+
+
   <div class="doc doc-children">
 
 
@@ -9111,7 +9585,7 @@ is equivalent to a Celery task state.</p>
 
     <div class="doc doc-contents ">
 
-      <p>Get the precedence for a state. Lower index means higher precedence.</p>
+        <p>Get the precedence for a state. Lower index means higher precedence.</p>
 
 
 <p><span class="doc-section-title">Parameters:</span></p>
@@ -9126,9 +9600,11 @@ is equivalent to a Celery task state.</p>
       </thead>
       <tbody>
           <tr class="doc-section-item">
-            <td><code>state</code></td>
             <td>
-                  <code><autoref identifier="str" optional>str</autoref></code>
+                <code>state</code>
+            </td>
+            <td>
+                  <code>str</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9154,7 +9630,7 @@ is equivalent to a Celery task state.</p>
       <tbody>
           <tr class="doc-section-item">
             <td>
-                  <code><autoref identifier="int" optional>int</autoref></code>
+                  <code>int</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9195,7 +9671,7 @@ is equivalent to a Celery task state.</p>
 
     <div class="doc doc-contents ">
 
-      <p>Unpack a grouped choices hierarchy into a flat list of two-tuples. For example:</p>
+        <p>Unpack a grouped choices hierarchy into a flat list of two-tuples. For example:</p>
 <p>choices = (
     ('Foo', (
         (1, 'A'),
@@ -9368,7 +9844,7 @@ is equivalent to a Celery task state.</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>