nautobot 2.2.1__py3-none-any.whl → 2.2.3__py3-none-any.whl

nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/upgrading-from-nautobot-v1.html

@@ -12993,16 +12993,19 @@ Most removed database fields in Nautobot 2.0 fall into the following general cat
 <p>See <a href="../../../../development/jobs/migration/from-v1.html">Migrating Jobs From Nautobot v1</a> for more information on how to migrate your existing jobs to Nautobot v2.</p>
 </div>
 <h3 id="fundamental-changes">Fundamental Changes<a class="headerlink" href="#fundamental-changes" title="Permanent link">&para;</a></h3>
-<p>The <code>BaseJob</code> class is now a subclass of Celery's <code>Task</code> class. Some fundamental changes to the job's methods and signatures were required to support this change:</p>
+<div class="admonition version-changed">
+<p class="admonition-title">Changed in version 2.2.3</p>
+<p>In Nautobot 2.0.0 through 2.2.2, Nautobot's <code>BaseJob</code> class was made to be a subclass of Celery's <code>Task</code> class. The implications of this change are outside the scope of this document, but this change has been reverted in Nautobot 2.2.3 and later.</p>
+</div>
 <ul>
-<li>The <code>test_*</code> and <code>post_run</code> methods for backwards compatibility to NetBox scripts and reports were removed. Celery implements <code>before_start</code>, <code>on_success</code>, <code>on_retry</code>, <code>on_failure</code>, and <code>after_return</code> methods that can be used by job authors to perform similar functions.</li>
+<li>The <code>test_*</code> and <code>post_run</code> methods for backwards compatibility to NetBox scripts and reports were removed. In their place, Nautobot Jobs now have <code>before_start</code>, <code>on_success</code>, <code>on_failure</code>, and <code>after_return</code> methods that can be used by job authors to perform similar functions.</li>
 </ul>
 <div class="admonition important">
 <p class="admonition-title">Important</p>
 <p>Be sure to call the <code>super()</code> method when overloading any of the job's <code>before_start</code>, <code>on_success</code>, <code>on_retry</code>, <code>on_failure</code>, or <code>after_return</code> methods</p>
 </div>
 <ul>
-<li>The run method signature is now customizable by the job author. This means that the <code>data</code> and <code>commit</code> arguments are no longer passed to the job by default and the job's run method signature should match the the job's input variables.</li>
+<li>The <code>run</code> method signature now includes each of the input variables defined on the Job. This means that the <code>data</code> and <code>commit</code> arguments are no longer passed to the job by default and the job's run method signature should match the the job's input variables.</li>
 </ul>
 <div class="admonition example">
 <p class="admonition-title">Example</p>
@@ -13012,7 +13015,7 @@ Most removed database fields in Nautobot 2.0 fall into the following general cat
 <a id="__codelineno-12-4" name="__codelineno-12-4" href="#__codelineno-12-4"></a>    <span class="n">var3</span> <span class="o">=</span> <span class="n">BooleanVar</span><span class="p">()</span>
 <a id="__codelineno-12-5" name="__codelineno-12-5" href="#__codelineno-12-5"></a>    <span class="n">var4</span> <span class="o">=</span> <span class="n">ObjectVar</span><span class="p">(</span><span class="n">model</span><span class="o">=</span><span class="n">Role</span><span class="p">)</span>
 <a id="__codelineno-12-6" name="__codelineno-12-6" href="#__codelineno-12-6"></a>
-<a id="__codelineno-12-7" name="__codelineno-12-7" href="#__codelineno-12-7"></a>    <span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">var1</span><span class="p">,</span> <span class="n">var2</span><span class="p">,</span> <span class="n">var3</span><span class="p">,</span> <span class="n">var4</span><span class="p">):</span>
+<a id="__codelineno-12-7" name="__codelineno-12-7" href="#__codelineno-12-7"></a>    <span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">var1</span><span class="p">,</span> <span class="n">var2</span><span class="p">,</span> <span class="n">var3</span><span class="p">,</span> <span class="n">var4</span><span class="p">):</span>
 <a id="__codelineno-12-8" name="__codelineno-12-8" href="#__codelineno-12-8"></a>        <span class="o">...</span>
 </code></pre></div>
 </div>

nautobot/project-static/docs/user-guide/core-data-model/ipam/vlan.html

@@ -3534,6 +3534,17 @@
         
       
       
+        <label class="md-nav__link md-nav__link--active" for="__toc">
+          
+  
+  <span class="md-ellipsis">
+    VLAN
+  </span>
+  
+
+          <span class="md-nav__icon md-icon"></span>
+        </label>
+      
       <a href="vlan.html" class="md-nav__link md-nav__link--active">
         
   
@@ -3544,6 +3555,58 @@
 
       </a>
       
+        
+
+<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+  
+  
+  
+    
+  
+  
+    <label class="md-nav__title" for="__toc">
+      <span class="md-nav__icon md-icon"></span>
+      Table of contents
+    </label>
+    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
+      
+        <li class="md-nav__item">
+  <a href="#modeling-vlans" class="md-nav__link">
+    <span class="md-ellipsis">
+      Modeling VLANs
+    </span>
+  </a>
+  
+    <nav class="md-nav" aria-label="Modeling VLANs">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#multiple-locations-using-same-vlan-id" class="md-nav__link">
+    <span class="md-ellipsis">
+      Multiple Locations Using Same VLAN ID
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#multiple-locations-stretched-layer-2" class="md-nav__link">
+    <span class="md-ellipsis">
+      Multiple Locations, Stretched Layer 2
+    </span>
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
+</li>
+      
+    </ul>
+  
+</nav>
+      
     </li>
   
 
@@ -7711,6 +7774,47 @@
     
   
   
+    <label class="md-nav__title" for="__toc">
+      <span class="md-nav__icon md-icon"></span>
+      Table of contents
+    </label>
+    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
+      
+        <li class="md-nav__item">
+  <a href="#modeling-vlans" class="md-nav__link">
+    <span class="md-ellipsis">
+      Modeling VLANs
+    </span>
+  </a>
+  
+    <nav class="md-nav" aria-label="Modeling VLANs">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#multiple-locations-using-same-vlan-id" class="md-nav__link">
+    <span class="md-ellipsis">
+      Multiple Locations Using Same VLAN ID
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#multiple-locations-stretched-layer-2" class="md-nav__link">
+    <span class="md-ellipsis">
+      Multiple Locations, Stretched Layer 2
+    </span>
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
+</li>
+      
+    </ul>
+  
 </nav>
                   </div>
                 </div>
@@ -7752,6 +7856,13 @@
 <li>Replaced <code>location</code> ForeignKey field with <code>locations</code> ManyToManyField, allowing a VLAN to be assigned to multiple Locations.</li>
 </ul>
 </div>
+<h2 id="modeling-vlans">Modeling VLANs<a class="headerlink" href="#modeling-vlans" title="Permanent link">&para;</a></h2>
+<p>With the update to Nautobot 2.2 that introduced the ability to have a single VLAN be associated to multiple locations, there needs to be some <em>recommended</em> methods to model VLANs with the new functionality.</p>
+<p>You should be looking to model VLANs in the same way that the layer 2 functionality is set up.</p>
+<h3 id="multiple-locations-using-same-vlan-id">Multiple Locations Using Same VLAN ID<a class="headerlink" href="#multiple-locations-using-same-vlan-id" title="Permanent link">&para;</a></h3>
+<p>In many organizations the use of cookiecutter like VLAN architecture is leveraged. In that a location may have VLAN30 be for the same purpose (ie Wireless, User, Voice) at each location. In this scenario, you should model a distinct VLAN30 in Nautobot for each Location. Creating a single VLAN and then associating it with multiple Locations would not accurately reflect the state of the layer 2 network.</p>
+<h3 id="multiple-locations-stretched-layer-2">Multiple Locations, Stretched Layer 2<a class="headerlink" href="#multiple-locations-stretched-layer-2" title="Permanent link">&para;</a></h3>
+<p>You would want to have a single VLAN that is associated with multiple Locations when the layer 2 environment is in fact stretched and devices within the VLAN are able to communicate via layer 2 mechanisms. Such designs include a campus network where you do have multiple Locations but a shared VLAN across all of them, for example wireless networks. Or in a data center fabric where the layer 2 is in fact stretched across the sites.</p>
 
 
 

nautobot/project-static/docs/user-guide/platform-functionality/jobs/index.html

@@ -7724,21 +7724,6 @@
     </span>
   </a>
   
-    <nav class="md-nav" aria-label="Enabling Jobs for Running">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#enabling-job-hooks" class="md-nav__link">
-    <span class="md-ellipsis">
-      Enabling Job Hooks
-    </span>
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
 </li>
         
           <li class="md-nav__item">
@@ -7869,6 +7854,16 @@
 </div>
 <h2 id="managing-jobs">Managing Jobs<a class="headerlink" href="#managing-jobs" title="Permanent link">&para;</a></h2>
 <p>As of Nautobot 1.3, each Job class installed in Nautobot is represented by a corresponding Job data record in the Nautobot database. These data records are refreshed when the <code>nautobot-server migrate</code> or <code>nautobot-server post_upgrade</code> command is run, or (for Jobs from a Git repository) when a Git repository is enabled or re-synced in Nautobot. These data records make it possible for an administrative user (or other user with appropriate access privileges) to exert a level of administrative control over the Jobs created and updated by Job authors.</p>
+<div class="admonition tip">
+<p class="admonition-title">Tip</p>
+<p>A "Job" can refer to one of two different constructs. There are both the actual Python code that implements the logic of a Job as a Python class, and the Nautobot database model that represents a given Job class in the database. In cases where the distinction between these objects is important, we refer to the first as a "Job class", and the second as a "Job model" or "Job record".</p>
+<p>It's important to understand this dichotomy, as actions that change one may not necessarily update the other. For example:</p>
+<ul>
+<li>Editing or replacing a Python file in your <code>JOBS_ROOT</code> directory will update the Job <em>class</em> on disk, but will not automatically refresh the Job <em>record</em> corresponding to this class - you must run <code>nautobot-server post_upgrade</code> to make this happen.</li>
+<li>Changing the metadata of a Job <em>record</em> (e.g., assigning it a different categorical <code>grouping</code>) is recorded as an override of the default grouping defined by the Job <em>class</em> source code; it does not in any way change the source code of the Job class.</li>
+</ul>
+<p>The Job <em>model</em> is used to enforce user permissions, present information about the Job to the user, and so forth, while actually executing the Job makes use of the Job <em>class</em> only.</p>
+</div>
 <h3 id="enabling-jobs-for-running">Enabling Jobs for Running<a class="headerlink" href="#enabling-jobs-for-running" title="Permanent link">&para;</a></h3>
 <p>When a new Job record is created for a newly discovered Job class, it defaults to <code>enabled = False</code>, which prevents the Job from being run by any user. This is intended to provide a level of security and oversight regarding the installation of new Jobs into Nautobot.</p>
 <div class="admonition important">
@@ -7884,18 +7879,6 @@
 <li>In the second section titled <strong>Job</strong>, select the <strong>Enabled</strong> checkbox</li>
 <li>Select <strong>Update</strong> button at the bottom</li>
 </ul>
-<h4 id="enabling-job-hooks">Enabling Job Hooks<a class="headerlink" href="#enabling-job-hooks" title="Permanent link">&para;</a></h4>
-<p>Job hooks are enabled in a similar fashion, but by using the <strong>default</strong> filters when navigating to the Jobs page the Job Hooks will not be visible. To enable job hooks:</p>
-<ul>
-<li>Navigate to Jobs &gt; Jobs menu</li>
-<li>Select the <strong>Filter</strong> button to bring up the Filter Jobs context</li>
-<li>Look for <strong>Is job hook receiver</strong> and change the drop down to <strong>Yes</strong></li>
-<li>Select <strong>Apply</strong> button</li>
-<li>Select a job that has been installed</li>
-<li>Select <strong>Edit</strong> button</li>
-<li>In the second section titled <strong>Job</strong>, select the <strong>Enabled</strong> checkbox</li>
-<li>Select <strong>Update</strong> button at the bottom</li>
-</ul>
 <h3 id="overriding-metadata">Overriding Metadata<a class="headerlink" href="#overriding-metadata" title="Permanent link">&para;</a></h3>
 <p>An administrator or user with <code>extras.change_job</code> permission can also edit a Job database record to optionally override any or all of the following metadata attributes defined by the Job module or class:</p>
 <ul>
@@ -7913,6 +7896,10 @@
 <p>This is done by setting the corresponding "override" flag (<code>grouping_override</code>, <code>name_override</code>, etc.) to <code>True</code> then providing a new value for the attribute in question. An overridden attribute will remain set to its overridden value even if the underlying Job class definition changes and <code>nautobot-server &lt;migrate|post_upgrade&gt;</code> gets run again. Conversely, clearing the "override" flag for an attribute and saving the database record will revert the attribute to the underlying value defined within the Job class source code.</p>
 <h3 id="deleting-jobs">Deleting Jobs<a class="headerlink" href="#deleting-jobs" title="Permanent link">&para;</a></h3>
 <p>When a previously installed Job class is removed, after running <code>nautobot-server &lt;migrate|post_upgrade&gt;</code> or refreshing the providing Git repository, the Job database record will <em>not</em> be automatically deleted, but <em>will</em> be flagged as <code>installed = False</code> and can no longer be run or scheduled.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The Job list view hides by default any Jobs that are not installed. To view non-installed Job records, you need to select the "Filter" button in the list view and explicitly specify the filter "Installed: No".</p>
+</div>
 <p>An administrator or user with <code>extras.delete_job</code> permissions <em>may</em> delete such a Job database record if desired, but be aware that doing so will result in any existing JobResult or ScheduledJob records that originated from this Job losing their association to the Job; this association will not be automatically restored even if the Job is later reinstalled or reintroduced.</p>
 <h2 id="running-jobs">Running Jobs<a class="headerlink" href="#running-jobs" title="Permanent link">&para;</a></h2>
 <div class="admonition note">
@@ -7928,7 +7915,7 @@
 </div>
 <p>It is a key concept to understand the 2 <code>class_path</code> elements:</p>
 <ul>
-<li><code>module_name</code>: which is the importable Python path to the job definition (with <code>.</code> in place of <code>/</code> in the directory path, and not including the <code>.py</code> file extension, as per Python syntax standards).<ul>
+<li><code>module_name</code>: which is the importable Python path to the job class definition (with <code>.</code> in place of <code>/</code> in the directory path, and not including the <code>.py</code> file extension, as per Python syntax standards).<ul>
 <li>For an App-provided job, this might be something like <code>my_app_name.jobs.my_job_filename</code> or <code>nautobot_golden_config.jobs</code></li>
 <li>For a locally installed job, this would match the file name, such as <code>my_job_filename</code></li>
 <li>For a Git-provided job, this includes the repository's defined <code>slug</code>, such as <code>my_repository.jobs.my_job_filename</code></li>

nautobot/project-static/docs/user-guide/platform-functionality/jobs/models.html

@@ -7824,7 +7824,7 @@
 <div class="admonition version-added">
 <p class="admonition-title">Added in version 1.3.0</p>
 </div>
-<p>The Job data model provides a database representation of metadata describing a specific installed Job. It also serves as an anchor point for other data models (JobResult and ScheduledJob in particular) to link against.</p>
+<p>The Job data model provides a database representation of metadata describing a specific installed Job class. It also serves as an anchor point for other data models (JobResult and ScheduledJob in particular) to link against.</p>
 <p>For any given Job record, most of its fields are populated initially from data defined in the source code of the corresponding job class. These fields may be explicitly overridden by editing the Job record via the Nautobot UI or REST API if desired. This is generally accomplished by setting a value for the desired field (e.g. <code>grouping</code>) and also setting the corresponding <code>override</code> flag (e.g. <code>grouping_override</code>) to <code>True</code>. If the <code>override</code> flag for a field is cleared (set back to <code>False</code>) then the corresponding flag will automatically revert to the original value defined by the Job class source code when the record is saved.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
@@ -7834,10 +7834,10 @@
 <p>Records of this type store the following data as read-only (not modifiable via the UI or REST API):</p>
 <ul>
 <li>The source of the job (local installation, Git repository, App)</li>
-<li>The name of the module containing the Job</li>
+<li>The name of the module containing the Job class</li>
 <li>The name of the Job class</li>
-<li>Whether the job is installed presently</li>
-<li>Whether the job is read-only</li>
+<li>Whether the job class is installed presently</li>
+<li>Whether the job is self-described as "read-only"</li>
 <li>Whether the job is a <a href="jobhook.html#job-hook-receivers">Job Hook Receiver</a></li>
 <li>Whether the job is a <a href="jobbutton.html#job-button-receivers">Job Button Receiver</a></li>
 </ul>

nautobot/project-static/js/forms.js

@@ -632,18 +632,19 @@ function initializeDynamicFilterForm(context){
 
     // Remove applied filters
     this_context.find(".remove-filter-param").on("click", function(){
-        let query_params = location.search;
+        let query_params = new URLSearchParams(location.search);
         let type = $(this).attr("data-field-type");
         let field_value = $(this).attr("data-field-value");
-        let query_string = location.search.substr(1).split("&");
 
         if (type === "parent") {
-            query_string = query_string.filter(item => item.search(field_value) < 0);
+            // Remove all instances of this query param
+            query_params.delete(field_value);
         } else {
+            // Remove this specific instance of this query param
             let parent = $(this).attr("data-field-parent");
-            query_string = query_string.filter(item => item.search(parent + "=" + field_value) < 0)
+            query_params.delete(parent, field_value);
         }
-        location.replace("?" + query_string.join("&"))
+        location.assign("?" + query_params);
     })
 
     // On submit of filter form
@@ -657,12 +658,18 @@ function initializeDynamicFilterForm(context){
         q_field_phantom.val(q_field.val())
         dynamic_form.append(q_field_phantom);
 
-        // Get the serialize data from the forms and filter out query_params which values are empty e.g ?sam=&dan=2 becomes dan=2
-        let dynamic_filter_form_query = $("#dynamic-filter-form").serialize().split("&").filter(params => params.split("=")[1]?.length || 0 )
-        let default_filter_form_query = $("#default-filter form").serialize().split("&").filter(params => params.split("=")[1]?.length || 0 )
-        // Union Operation
-        let search_query = [...new Set([...default_filter_form_query, ...dynamic_filter_form_query])].join("&")
-        location.replace("?" + search_query)
+        // Get the serialized data from the forms and:
+        // 1) filter out query_params which values are empty e.g ?sam=&dan=2 becomes dan=2
+        // 2) combine the two forms into a single set of data without duplicate entries
+        let search_query = new URLSearchParams();
+        let dynamic_query = new URLSearchParams(new FormData(document.getElementById("dynamic-filter-form")));
+        dynamic_query.forEach((value, key) => { if (value != "") { search_query.append(key, value); }});
+        let default_query = new URLSearchParams(new FormData(document.getElementById("default-filter").firstElementChild));
+        default_query.forEach((value, key) => {
+            if (value != "" && !search_query.has(key, value)) { search_query.append(key, value); }
+        });
+        $("#FilterForm_modal").modal("hide");
+        location.assign("?" + search_query);
     })
 
     // On submit of filter search form

{nautobot-2.2.1.dist-info → nautobot-2.2.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nautobot
-Version: 2.2.1
+Version: 2.2.3
 Summary: Source of truth and network automation platform.
 Home-page: https://nautobot.com
 License: Apache-2.0
@@ -67,8 +67,8 @@ Requires-Dist: prometheus-client (>=0.20.0,<0.21.0)
 Requires-Dist: psycopg2-binary (>=2.9.9,<2.10.0)
 Requires-Dist: python-slugify (>=8.0.3,<8.1.0)
 Requires-Dist: pyuwsgi (>=2.0.23,<2.1.0)
-Requires-Dist: social-auth-app-django (>=5.4.0,<5.5.0)
-Requires-Dist: social-auth-core[openidconnect,saml] (>=4.5.3,<4.6.0) ; extra == "all" or extra == "sso"
+Requires-Dist: social-auth-app-django (>=5.4.1,<5.5.0)
+Requires-Dist: social-auth-core[saml] (>=4.5.3,<4.6.0) ; extra == "all" or extra == "sso"
 Requires-Dist: svgwrite (>=1.4.2,<1.5.0)
 Project-URL: Documentation, https://docs.nautobot.com
 Project-URL: Repository, https://github.com/nautobot/nautobot