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

nautobot/project-static/docs/code-reference/nautobot/apps/exceptions.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">
         
@@ -8176,11 +8218,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>
   
 
@@ -9198,7 +9240,12 @@
 
     <div class="doc doc-contents first">
 
-      <p>Exceptions for Nautobot apps.</p>
+        <p>Exceptions for Nautobot apps.</p>
+
+
+
+
+
 
 
 
@@ -9224,10 +9271,15 @@
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="Exception" optional>Exception</autoref></code></p>
+              Bases: <code>Exception</code></p>
+
+
+        <p>An exception used to trigger a database transaction rollback.</p>
+
+
+
 
 
-      <p>An exception used to trigger a database transaction rollback.</p>
 
 
     </div>
@@ -9247,15 +9299,20 @@
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="rest_framework.exceptions.APIException" optional hover>APIException</autoref></code></p>
+              Bases: <code><span title="rest_framework.exceptions.APIException">APIException</span></code></p>
 
 
-      <p>Indicates the temporary inability to enqueue a new Celery task (e.g. custom script execution) because
+        <p>Indicates the temporary inability to enqueue a new Celery task (e.g. custom script execution) because
 no Celery worker processes are currently running.</p>
 
 
 
 
+
+
+
+
+
   <div class="doc doc-children">
 
 
@@ -9287,10 +9344,15 @@ no Celery worker processes are currently running.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="Exception" optional>Exception</autoref></code></p>
+              Bases: <code>Exception</code></p>
+
+
+        <p>Deprecated - no longer used in Nautobot core.</p>
+
+
+
 
 
-      <p>Deprecated - no longer used in Nautobot core.</p>
 
 
     </div>
@@ -9310,10 +9372,15 @@ no Celery worker processes are currently running.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="Exception" optional>Exception</autoref></code></p>
+              Bases: <code>Exception</code></p>
+
+
+        <p>An exception indicating that a filterset field could not be found.</p>
+
+
+
 
 
-      <p>An exception indicating that a filterset field could not be found.</p>
 
 
     </div>
@@ -9333,10 +9400,15 @@ no Celery worker processes are currently running.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="Exception" optional>Exception</autoref></code></p>
+              Bases: <code>Exception</code></p>
+
+
+        <p>General purpose exception class for failures raised when secret value access fails.</p>
+
+
+
 
 
-      <p>General purpose exception class for failures raised when secret value access fails.</p>
 
 
 
@@ -9372,10 +9444,10 @@ no Celery worker processes are currently running.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="nautobot.extras.secrets.exceptions.SecretError" optional hover>SecretError</autoref></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.secrets.exceptions.SecretError" href="#nautobot.apps.exceptions.SecretError">SecretError</a></code></p>
 
 
-      <p>Exception raised when a Secret record's parameters are incorrectly specified.</p>
+        <p>Exception raised when a Secret record's parameters are incorrectly specified.</p>
 <p>Normally this should be caught during input validation of the Secret record, but in the case of direct
 ORM access bypassing the usual clean() functionality, it's possible to create a mis-defined Secret which
 would trigger this exception upon access.</p>
@@ -9383,6 +9455,11 @@ would trigger this exception upon access.</p>
 
 
 
+
+
+
+
+
   <div class="doc doc-children">
 
 
@@ -9414,10 +9491,15 @@ would trigger this exception upon access.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="nautobot.extras.secrets.exceptions.SecretError" optional hover>SecretError</autoref></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.secrets.exceptions.SecretError" href="#nautobot.apps.exceptions.SecretError">SecretError</a></code></p>
+
+
+        <p>General purpose exception class for failures that indicate that a secrets provider is not working correctly.</p>
+
+
+
 
 
-      <p>General purpose exception class for failures that indicate that a secrets provider is not working correctly.</p>
 
 
 
@@ -9453,10 +9535,15 @@ would trigger this exception upon access.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="nautobot.extras.secrets.exceptions.SecretError" optional hover>SecretError</autoref></code>, <code><autoref identifier="KeyError" optional>KeyError</autoref></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.secrets.exceptions.SecretError" href="#nautobot.apps.exceptions.SecretError">SecretError</a></code>, <code>KeyError</code></p>
+
+
+        <p>Exception raised when a secrets provider is operating normally but a specific requested secret is not found.</p>
+
+
+
 
 
-      <p>Exception raised when a secrets provider is operating normally but a specific requested secret is not found.</p>
 
 
 
@@ -9633,7 +9720,7 @@ would trigger this exception upon access.</p>
     <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/factory.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">
         
@@ -8191,11 +8233,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>
   
 
@@ -9228,7 +9270,12 @@
 
     <div class="doc doc-contents first">
 
-      <p>Nautobot classes and utilities for factory boy.</p>
+        <p>Nautobot classes and utilities for factory boy.</p>
+
+
+
+
+
 
 
 
@@ -9254,10 +9301,15 @@
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="factory.django.DjangoModelFactory" optional hover>DjangoModelFactory</autoref></code></p>
+              Bases: <code><span title="factory.django.DjangoModelFactory">DjangoModelFactory</span></code></p>
+
+
+        <p>Base class for all Nautobot model factories.</p>
+
+
+
 
 
-      <p>Base class for all Nautobot model factories.</p>
 
 
 
@@ -9293,10 +9345,10 @@
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="factory.Iterator" optional hover>Iterator</autoref></code></p>
+              Bases: <code><span title="factory.Iterator">Iterator</span></code></p>
 
 
-      <p>Factory iterator that returns a semi-random sampling of boolean values</p>
+        <p>Factory iterator that returns a semi-random sampling of boolean values</p>
 <p>Iterator that returns a random sampling of True and False values while limiting
 the number of repeated values in a given number of iterations. Used in factories
 when a data set must contain both True and False values.</p>
@@ -9314,9 +9366,11 @@ when a data set must contain both True and False values.</p>
       </thead>
       <tbody>
           <tr class="doc-section-item">
-            <td><code>cycle</code></td>
             <td>
-                  <code><autoref identifier="boolean" optional>boolean</autoref></code>
+                <code>cycle</code>
+            </td>
+            <td>
+                  <code>boolean</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9330,9 +9384,11 @@ Defaults to True.</p>
             </td>
           </tr>
           <tr class="doc-section-item">
-            <td><code>chance_of_getting_true</code></td>
             <td>
-                  <code><autoref identifier="int" optional>int</autoref></code>
+                <code>chance_of_getting_true</code>
+            </td>
+            <td>
+                  <code>int</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9341,13 +9397,15 @@ set to True. Defaults to 50.</p>
               </div>
             </td>
             <td>
-                  <code><autoref identifier="nautobot.core.constants.NAUTOBOT_BOOL_ITERATOR_DEFAULT_PROBABILITY" optional hover>NAUTOBOT_BOOL_ITERATOR_DEFAULT_PROBABILITY</autoref></code>
+                  <code><span title="nautobot.core.constants.NAUTOBOT_BOOL_ITERATOR_DEFAULT_PROBABILITY">NAUTOBOT_BOOL_ITERATOR_DEFAULT_PROBABILITY</span></code>
             </td>
           </tr>
           <tr class="doc-section-item">
-            <td><code>length</code></td>
             <td>
-                  <code><autoref identifier="int" optional>int</autoref></code>
+                <code>length</code>
+            </td>
+            <td>
+                  <code>int</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9355,7 +9413,7 @@ set to True. Defaults to 50.</p>
               </div>
             </td>
             <td>
-                  <code><autoref identifier="nautobot.core.constants.NAUTOBOT_BOOL_ITERATOR_DEFAULT_LENGTH" optional hover>NAUTOBOT_BOOL_ITERATOR_DEFAULT_LENGTH</autoref></code>
+                  <code><span title="nautobot.core.constants.NAUTOBOT_BOOL_ITERATOR_DEFAULT_LENGTH">NAUTOBOT_BOOL_ITERATOR_DEFAULT_LENGTH</span></code>
             </td>
           </tr>
       </tbody>
@@ -9364,6 +9422,11 @@ set to True. Defaults to 50.</p>
 
 
 
+
+
+
+
+
   <div class="doc doc-children">
 
 
@@ -9395,10 +9458,15 @@ set to True. Defaults to 50.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="faker.providers.BaseProvider" optional hover>BaseProvider</autoref></code></p>
+              Bases: <code><span title="faker.providers.BaseProvider">BaseProvider</span></code></p>
+
+
+        <p>Faker provider to generate fake data specific to Nautobot or network automation use cases.</p>
+
+
+
 
 
-      <p>Faker provider to generate fake data specific to Nautobot or network automation use cases.</p>
 
 
 
@@ -9424,7 +9492,7 @@ set to True. Defaults to 50.</p>
 
     <div class="doc doc-contents ">
 
-      <p>Produce a random IPv6 network with a valid CIDR greater than 0</p>
+        <p>Produce a random IPv6 network with a valid CIDR greater than 0</p>
 
     </div>
 
@@ -9451,10 +9519,15 @@ set to True. Defaults to 50.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="nautobot.core.factory.BaseModelFactory" optional hover>BaseModelFactory</autoref></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.factory.BaseModelFactory" href="#nautobot.apps.factory.BaseModelFactory">BaseModelFactory</a></code></p>
+
+
+        <p>Factory base class for OrganizationalModel subclasses.</p>
+
+
+
 
 
-      <p>Factory base class for OrganizationalModel subclasses.</p>
 
 
 
@@ -9490,10 +9563,15 @@ set to True. Defaults to 50.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="nautobot.core.factory.BaseModelFactory" optional hover>BaseModelFactory</autoref></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.factory.BaseModelFactory" href="#nautobot.apps.factory.BaseModelFactory">BaseModelFactory</a></code></p>
+
+
+        <p>Factory base class for PrimaryModel subclasses.</p>
+
+
+
 
 
-      <p>Factory base class for PrimaryModel subclasses.</p>
 
 
 
@@ -9529,10 +9607,15 @@ set to True. Defaults to 50.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="factory.Faker" optional hover>Faker</autoref></code></p>
+              Bases: <code><span title="factory.Faker">Faker</span></code></p>
+
+
+        <p>https://github.com/FactoryBoy/factory_boy/pull/820#issuecomment-1004802669</p>
+
+
+
 
 
-      <p>https://github.com/FactoryBoy/factory_boy/pull/820#issuecomment-1004802669</p>
 
 
 
@@ -9567,7 +9650,7 @@ set to True. Defaults to 50.</p>
 
     <div class="doc doc-contents ">
 
-      <p>Factory helper - retrieve a random number of instances of the given model.</p>
+        <p>Factory helper - retrieve a random number of instances of the given model.</p>
 <p>This is different from random_instance() in that it's not itself a lazy function generator, but should instead be
 called only from within a @lazy_attribute or @post_generation function.</p>
 <p>This is not an evenly weighted distribution (all counts equally likely), because in most of our code,
@@ -9590,9 +9673,11 @@ the relevant code paths distinguish between 0, 1, or &gt;1 instances - there's n
       </thead>
       <tbody>
           <tr class="doc-section-item">
-            <td><code>model_or_queryset_or_lambda</code></td>
             <td>
-                  <code><autoref identifier="Union" optional>Union</autoref>[<autoref identifier="BaseModel" optional>BaseModel</autoref>, <autoref identifier="QuerySet" optional>QuerySet</autoref>, <autoref identifier="func" optional>func</autoref>]</code>
+                <code>model_or_queryset_or_lambda</code>
+            </td>
+            <td>
+                  <code>Union[BaseModel, QuerySet, func]</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9604,9 +9689,11 @@ the relevant code paths distinguish between 0, 1, or &gt;1 instances - there's n
             </td>
           </tr>
           <tr class="doc-section-item">
-            <td><code>minimum</code></td>
             <td>
-                  <code><autoref identifier="int" optional>int</autoref></code>
+                <code>minimum</code>
+            </td>
+            <td>
+                  <code>int</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9618,9 +9705,11 @@ the relevant code paths distinguish between 0, 1, or &gt;1 instances - there's n
             </td>
           </tr>
           <tr class="doc-section-item">
-            <td><code>maximum</code></td>
             <td>
-                  <code><autoref identifier="int" optional>int</autoref></code>
+                <code>maximum</code>
+            </td>
+            <td>
+                  <code>int</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9649,7 +9738,7 @@ the relevant code paths distinguish between 0, 1, or &gt;1 instances - there's n
 
     <div class="doc doc-contents ">
 
-      <p>Factory helper - construct a LazyFunction that gets a random instance of the given model or queryset when evaluated.</p>
+        <p>Factory helper - construct a LazyFunction that gets a random instance of the given model or queryset when evaluated.</p>
 <p>TODO: once we have factories for all mandatory foreign keys, change allow_null default to False</p>
 
 
@@ -9665,9 +9754,11 @@ the relevant code paths distinguish between 0, 1, or &gt;1 instances - there's n
       </thead>
       <tbody>
           <tr class="doc-section-item">
-            <td><code>model_or_queryset_or_lambda</code></td>
             <td>
-                  <code><autoref identifier="Union" optional>Union</autoref>[<autoref identifier="BaseModel" optional>BaseModel</autoref>, <autoref identifier="QuerySet" optional>QuerySet</autoref>, <autoref identifier="func" optional>func</autoref>]</code>
+                <code>model_or_queryset_or_lambda</code>
+            </td>
+            <td>
+                  <code>Union[BaseModel, QuerySet, func]</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9679,9 +9770,11 @@ the relevant code paths distinguish between 0, 1, or &gt;1 instances - there's n
             </td>
           </tr>
           <tr class="doc-section-item">
-            <td><code>allow_null</code></td>
             <td>
-                  <code><autoref identifier="bool" optional>bool</autoref></code>
+                <code>allow_null</code>
+            </td>
+            <td>
+                  <code>bool</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9875,7 +9968,7 @@ status = random_instance(lambda: Status.objects.get_for_model(Object), allow_nul
     <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>