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

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

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.46">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.49">
     
     
       
@@ -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>
       
@@ -5131,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">
         
@@ -8074,11 +8116,11 @@
   
   
     <li class="md-nav__item">
-      <a href="../../../development/core/local-k8s.html" class="md-nav__link">
+      <a href="../../../development/core/minikube-dev-environment-for-k8s-jobs.html" class="md-nav__link">
         
   
   <span class="md-ellipsis">
-    Local Kubernetes Cluster
+    Minikube Dev Environment for K8s Jobs
   </span>
   
 
@@ -9016,7 +9058,12 @@
 
     <div class="doc doc-contents first">
 
-      <p>Nautobot Constants.</p>
+        <p>Nautobot Constants.</p>
+
+
+
+
+
 
 
 
@@ -9183,7 +9230,7 @@
     <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.83f73b43.min.js"></script>
+      <script src="../../../assets/javascripts/bundle.88dd0f4e.min.js"></script>
       
         <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
       

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

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.46">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.49">
     
     
       
@@ -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>
       
@@ -5131,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">
         
@@ -8137,11 +8179,11 @@
   
   
     <li class="md-nav__item">
-      <a href="../../../development/core/local-k8s.html" class="md-nav__link">
+      <a href="../../../development/core/minikube-dev-environment-for-k8s-jobs.html" class="md-nav__link">
         
   
   <span class="md-ellipsis">
-    Local Kubernetes Cluster
+    Minikube Dev Environment for K8s Jobs
   </span>
   
 
@@ -9120,7 +9162,12 @@
 
     <div class="doc doc-contents first">
 
-      <p>Utilities for an app to register datasource contents (for Git, etc.).</p>
+        <p>Utilities for an app to register datasource contents (for Git, etc.).</p>
+
+
+
+
+
 
 
 
@@ -9161,9 +9208,11 @@
       </thead>
       <tbody>
           <tr class="doc-section-item">
-            <td><code>name</code></td>
             <td>
-                  <code><autoref identifier="str" optional>str</autoref></code>
+                <code>name</code>
+            </td>
+            <td>
+                  <code>str</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9175,9 +9224,11 @@
             </td>
           </tr>
           <tr class="doc-section-item">
-            <td><code>content_identifier</code></td>
             <td>
-                  <code><autoref identifier="str" optional>str</autoref></code>
+                <code>content_identifier</code>
+            </td>
+            <td>
+                  <code>str</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9189,9 +9240,11 @@
             </td>
           </tr>
           <tr class="doc-section-item">
-            <td><code>icon</code></td>
             <td>
-                  <code><autoref identifier="str" optional>str</autoref></code>
+                <code>icon</code>
+            </td>
+            <td>
+                  <code>str</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9203,9 +9256,11 @@
             </td>
           </tr>
           <tr class="doc-section-item">
-            <td><code>callback</code></td>
             <td>
-                  <code><autoref identifier="callable" optional>callable</autoref></code>
+                <code>callback</code>
+            </td>
+            <td>
+                  <code>callable</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9220,9 +9275,11 @@
             </td>
           </tr>
           <tr class="doc-section-item">
-            <td><code>weight</code></td>
             <td>
-                  <code><autoref identifier="int" optional>int</autoref></code>
+                <code>weight</code>
+            </td>
+            <td>
+                  <code>int</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9239,6 +9296,11 @@
 
 
 
+
+
+
+
+
   <div class="doc doc-children">
 
 
@@ -9260,7 +9322,7 @@
 
     <div class="doc doc-contents ">
 
-      <p>Ensure datasource properties.</p>
+        <p>Ensure datasource properties.</p>
 
     </div>
 
@@ -9286,7 +9348,7 @@
 
     <div class="doc doc-contents ">
 
-      <p>Returns the repo url with and without token when present
+        <p>Returns the repo url with and without token when present
 Returns:
     (str): The url used to connect to the git repo, with credentials as applicable.</p>
 
@@ -9447,7 +9509,7 @@ Returns:
     <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.83f73b43.min.js"></script>
+      <script src="../../../assets/javascripts/bundle.88dd0f4e.min.js"></script>
       
         <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
       

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

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.46">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.49">
     
     
       
@@ -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>
       
@@ -5131,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">
         
@@ -8203,11 +8245,11 @@
   
   
     <li class="md-nav__item">
-      <a href="../../../development/core/local-k8s.html" class="md-nav__link">
+      <a href="../../../development/core/minikube-dev-environment-for-k8s-jobs.html" class="md-nav__link">
         
   
   <span class="md-ellipsis">
-    Local Kubernetes Cluster
+    Minikube Dev Environment for K8s Jobs
   </span>
   
 
@@ -9252,7 +9294,12 @@
 
     <div class="doc doc-contents first">
 
-      <p>APIs for Nautobot event-notification subsystem.</p>
+        <p>APIs for Nautobot event-notification subsystem.</p>
+
+
+
+
+
 
 
 
@@ -9278,10 +9325,15 @@
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="abc.ABC" optional hover>ABC</autoref></code></p>
+              Bases: <code><span title="abc.ABC">ABC</span></code></p>
+
+
+        <p>Abstract base class for concrete implementations of event brokers such as syslog, Redis, Kafka, etc.</p>
+
+
+
 
 
-      <p>Abstract base class for concrete implementations of event brokers such as syslog, Redis, Kafka, etc.</p>
 
 
 
@@ -9311,7 +9363,7 @@
 
     <div class="doc doc-contents ">
 
-      <p>Possibly publish the given data <code>payload</code> to the given event <code>topic</code>.</p>
+        <p>Possibly publish the given data <code>payload</code> to the given event <code>topic</code>.</p>
 
 
 <p><span class="doc-section-title">Parameters:</span></p>
@@ -9326,9 +9378,11 @@
       </thead>
       <tbody>
           <tr class="doc-section-item">
-            <td><code>topic</code></td>
             <td>
-                  <code><autoref identifier="str" optional>str</autoref></code>
+                <code>topic</code>
+            </td>
+            <td>
+                  <code>str</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9343,9 +9397,11 @@ similar to Python logger naming. For example, you might receive topics such as <
             </td>
           </tr>
           <tr class="doc-section-item">
-            <td><code>payload</code></td>
             <td>
-                  <code><autoref identifier="dict" optional>dict</autoref></code>
+                <code>payload</code>
+            </td>
+            <td>
+                  <code>dict</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9386,10 +9442,15 @@ lowest common denominator for serializability.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="nautobot.core.events.base.EventBroker" optional hover>EventBroker</autoref></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.events.base.EventBroker" href="#nautobot.apps.events.EventBroker">EventBroker</a></code></p>
+
+
+        <p>EventBroker for publishing events to Redis.</p>
+
+
+
 
 
-      <p>EventBroker for publishing events to Redis.</p>
 
 
 
@@ -9415,7 +9476,7 @@ lowest common denominator for serializability.</p>
 
     <div class="doc doc-contents ">
 
-      <p>Initialize and configure a RedisEventBroker.</p>
+        <p>Initialize and configure a RedisEventBroker.</p>
 
 
 <p><span class="doc-section-title">Parameters:</span></p>
@@ -9430,9 +9491,11 @@ lowest common denominator for serializability.</p>
       </thead>
       <tbody>
           <tr class="doc-section-item">
-            <td><code>url</code></td>
             <td>
-                  <code><autoref identifier="str" optional>str</autoref></code>
+                <code>url</code>
+            </td>
+            <td>
+                  <code>str</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9471,7 +9534,12 @@ lowest common denominator for serializability.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="nautobot.core.events.base.EventBroker" optional hover>EventBroker</autoref></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.events.base.EventBroker" href="#nautobot.apps.events.EventBroker">EventBroker</a></code></p>
+
+
+
+
+
 
 
 
@@ -9498,7 +9566,7 @@ lowest common denominator for serializability.</p>
 
     <div class="doc doc-contents ">
 
-      <p>Initialize a SyslogEventBroker that emits logs at the given level.</p>
+        <p>Initialize a SyslogEventBroker that emits logs at the given level.</p>
 
     </div>
 
@@ -9524,7 +9592,7 @@ lowest common denominator for serializability.</p>
 
     <div class="doc doc-contents ">
 
-      <p>Deregister a previously registered <code>EventBroker</code> instance so that it no longer receives published events.</p>
+        <p>Deregister a previously registered <code>EventBroker</code> instance so that it no longer receives published events.</p>
 
     </div>
 
@@ -9541,7 +9609,7 @@ lowest common denominator for serializability.</p>
 
     <div class="doc doc-contents ">
 
-      <p>Publish the given event payload to the given topic via all registered <code>EventBroker</code> instances.</p>
+        <p>Publish the given event payload to the given topic via all registered <code>EventBroker</code> instances.</p>
 
 
 <p><span class="doc-section-title">Parameters:</span></p>
@@ -9556,9 +9624,11 @@ lowest common denominator for serializability.</p>
       </thead>
       <tbody>
           <tr class="doc-section-item">
-            <td><code>topic</code></td>
             <td>
-                  <code><autoref identifier="str" optional>str</autoref></code>
+                <code>topic</code>
+            </td>
+            <td>
+                  <code>str</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9574,9 +9644,11 @@ similar to Python logger naming. For example, you might use <code>nautobot.creat
             </td>
           </tr>
           <tr class="doc-section-item">
-            <td><code>payload</code></td>
             <td>
-                  <code><autoref identifier="dict" optional>dict</autoref></code>
+                <code>payload</code>
+            </td>
+            <td>
+                  <code>dict</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9607,7 +9679,7 @@ lowest common denominator for serializability.</p>
 
     <div class="doc doc-contents ">
 
-      <p>Register an <code>EventBroker</code> instance for use by Nautobot.</p>
+        <p>Register an <code>EventBroker</code> instance for use by Nautobot.</p>
 <p>The <code>publish_event()</code> API will publish events to each registered broker.
 The expectation/intent here, at least initially, is that a given deployment will instantiate zero or more
 EventBrokers, then call <code>register_event_broker()</code> for each one, as part of Nautobot initial startup.</p>
@@ -9625,9 +9697,11 @@ EventBrokers, then call <code>register_event_broker()</code> for each one, as pa
       </thead>
       <tbody>
           <tr class="doc-section-item">
-            <td><code>event_broker</code></td>
             <td>
-                  <code><autoref identifier="nautobot.core.events.base.EventBroker" optional hover>EventBroker</autoref></code>
+                <code>event_broker</code>
+            </td>
+            <td>
+                  <code><a class="autorefs autorefs-internal" title="nautobot.core.events.base.EventBroker" href="#nautobot.apps.events.EventBroker">EventBroker</a></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9798,7 +9872,7 @@ EventBrokers, then call <code>register_event_broker()</code> for each one, as pa
     <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.83f73b43.min.js"></script>
+      <script src="../../../assets/javascripts/bundle.88dd0f4e.min.js"></script>
       
         <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>