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

nautobot/project-static/docs/user-guide/administration/configuration/authentication/sso.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">
     
     
       
@@ -4265,6 +4265,27 @@
 
               
             
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../../core-data-model/dcim/virtualdevicecontext.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Virtual Device Context
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
       
@@ -4877,6 +4898,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="../../../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="../../../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="../../../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="../../../core-data-model/wireless/wirelessnetwork.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Wireless Network
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+          </ul>
+        </nav>
+      
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
       
@@ -5088,6 +5226,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../platform-functionality/events.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Event Notifications
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../../platform-functionality/exporttemplate.html" class="md-nav__link">
         
@@ -5162,7 +5321,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" >
         
           
           
@@ -5178,14 +5337,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>
@@ -5258,7 +5417,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" >
         
           
           
@@ -5274,14 +5433,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>
@@ -5356,6 +5515,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../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="../../../platform-functionality/jobs/job-scheduling-and-approvals.html" class="md-nav__link">
         
@@ -5469,6 +5649,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../platform-functionality/rendering-jinja-templates.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Rendering Jinja Templates
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     
     
     
@@ -5480,7 +5681,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" >
         
           
           
@@ -5496,14 +5697,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>
@@ -5723,10 +5924,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">
@@ -5737,8 +5938,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>
@@ -7143,6 +7344,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../../code-reference/nautobot/apps/events.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    nautobot.apps.events
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../../../code-reference/nautobot/apps/exceptions.html" class="md-nav__link">
         
@@ -7691,6 +7913,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>
       
@@ -8036,6 +8375,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">
         
@@ -8225,6 +8585,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">
         
@@ -8307,6 +8688,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">
         
@@ -9727,7 +10129,7 @@ a default set of permissions there are some additional variables to configure th
 <p>You may need to set <code>UWSGI_BUFFER_SIZE</code> to something bigger than the default 4096 bytes in the UWSGI config if you are seeing errors like <code>invalid request block size</code> in your application logs (see <a href="https://uwsgi-docs.readthedocs.io/en/latest/Options.html#buffer-size">here</a> for more information)</p>
 </div>
 <h2 id="group-syncing">Group Syncing<a class="headerlink" href="#group-syncing" title="Permanent link">&para;</a></h2>
-<p>To do so <code>nautobot.extras.group_sync.group_sync</code> must be part of <code>SOCIAL_AUTH_PIPELINE</code> which can be achieved
+<p>To do so <code>nautobot.extras.group_sync</code> must be part of <code>SOCIAL_AUTH_PIPELINE</code> which can be achieved
 by setting the environment variable <code>NAUTOBOT_SSO_ENABLE_GROUP_SYNC</code> to <code>true</code>. Or by setting
 the following in your settings:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a><span class="n">SOCIAL_AUTH_PIPELINE</span> <span class="o">=</span> <span class="p">(</span>
@@ -9740,7 +10142,7 @@ the following in your settings:</p>
 <a id="__codelineno-14-8" name="__codelineno-14-8" href="#__codelineno-14-8"></a>    <span class="s2">&quot;social_core.pipeline.social_auth.associate_user&quot;</span><span class="p">,</span>
 <a id="__codelineno-14-9" name="__codelineno-14-9" href="#__codelineno-14-9"></a>    <span class="s2">&quot;social_core.pipeline.social_auth.load_extra_data&quot;</span><span class="p">,</span>
 <a id="__codelineno-14-10" name="__codelineno-14-10" href="#__codelineno-14-10"></a>    <span class="s2">&quot;social_core.pipeline.user.user_details&quot;</span><span class="p">,</span>
-<a id="__codelineno-14-11" name="__codelineno-14-11" href="#__codelineno-14-11"></a>    <span class="s2">&quot;nautobot.extras.group_sync.group_sync&quot;</span><span class="p">,</span>
+<a id="__codelineno-14-11" name="__codelineno-14-11" href="#__codelineno-14-11"></a>    <span class="s2">&quot;nautobot.extras.group_sync&quot;</span><span class="p">,</span>
 <a id="__codelineno-14-12" name="__codelineno-14-12" href="#__codelineno-14-12"></a><span class="p">)</span>
 </code></pre></div>
 <p>You must then enable the scope that will provide your groups in your provider. The default
@@ -9903,10 +10305,10 @@ the default value of <code>"groups"</code>. For Azure you should override the va
     </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>