nautobot 2.4.15__py3-none-any.whl → 2.4.17__py3-none-any.whl

nautobot/project-static/docs/user-guide/core-data-model/extras/team.html

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.18">
     
     
       
@@ -35,6 +35,8 @@
   
   
     
+      
+      
     
   
   
@@ -7408,12 +7410,12 @@
   
   
     <li class="md-nav__item">
-      <a href="../../../development/apps/api/platform-features/populating-extensibility-features.html" class="md-nav__link">
+      <a href="../../../development/apps/api/platform-features/prepopulating-data.html" class="md-nav__link">
         
   
   
   <span class="md-ellipsis">
-    Populating Extensibility Features
+    Prepopulating Data
     
   </span>
   
@@ -10105,11 +10107,11 @@
 <details class="version-changed">
 <summary>Changed in version 2.2.1</summary>
 <p>A model can opt out of the ability to be associated with contacts or teams by specifying <code>is_contact_associable = False</code> in the model class definition. Note that presently this attribute only prevents contact/team related information from being displayed in the model UI and it does not actually prevent contacts/teams from associating to the model at the database level.</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="k">class</span> <span class="nc">YourModel</span><span class="p">(</span><span class="n">PrimaryModel</span><span class="p">):</span>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="k">class</span><span class="w"> </span><span class="nc">YourModel</span><span class="p">(</span><span class="n">PrimaryModel</span><span class="p">):</span>
 <a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>    <span class="n">name</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span><span class="n">max_length</span><span class="o">=</span><span class="n">CHARFIELD_MAX_LENGTH</span><span class="p">,</span> <span class="n">db_index</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
 <a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>    <span class="n">is_contact_associable_model</span> <span class="o">=</span> <span class="kc">False</span>
 <a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a>
-<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>    <span class="k">class</span> <span class="nc">Meta</span><span class="p">:</span>
+<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>    <span class="k">class</span><span class="w"> </span><span class="nc">Meta</span><span class="p">:</span>
 <a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a>        <span class="n">abstract</span> <span class="o">=</span> <span class="kc">True</span>
 </code></pre></div>
 </details>
@@ -10206,7 +10208,8 @@
 <!-- RTD version flyout injected on live site -->
 <div id="readthedocs-embed-flyout"></div>
       
-        <div class="md-social">
+        
+<div class="md-social">
   
     
     
@@ -10262,10 +10265,10 @@
     
     
       
-      <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.d50fe291.min.js", "tags": null, "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"}, "version": null}</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.973d3a69.min.js", "tags": null, "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"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.50899def.min.js"></script>
+      <script src="../../../assets/javascripts/bundle.92b07e13.min.js"></script>
       
     
   <script id="init-glightbox">const lightbox = GLightbox({"touchNavigation": true, "loop": false, "zoomable": true, "draggable": true, "openEffect": "zoom", "closeEffect": "zoom", "slideEffect": "slide"});

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

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.18">
     
     
       
@@ -35,6 +35,8 @@
   
   
     
+      
+      
     
   
   
@@ -4639,18 +4641,18 @@
 </li>
       
         <li class="md-nav__item">
-  <a href="#ipaddress-parenting-concrete-relationship" class="md-nav__link">
+  <a href="#de-duplicating-ipaddresses" class="md-nav__link">
     <span class="md-ellipsis">
-      IPAddress Parenting Concrete Relationship
+      De-duplicating IPAddresses
     </span>
   </a>
   
 </li>
       
         <li class="md-nav__item">
-  <a href="#de-duplicating-ipaddresses" class="md-nav__link">
+  <a href="#repairing-prefix-and-ip-address-hierarchy" class="md-nav__link">
     <span class="md-ellipsis">
-      De-duplicating IPAddresses
+      Repairing Prefix and IP Address Hierarchy
     </span>
   </a>
   
@@ -7467,12 +7469,12 @@
   
   
     <li class="md-nav__item">
-      <a href="../../../development/apps/api/platform-features/populating-extensibility-features.html" class="md-nav__link">
+      <a href="../../../development/apps/api/platform-features/prepopulating-data.html" class="md-nav__link">
         
   
   
   <span class="md-ellipsis">
-    Populating Extensibility Features
+    Prepopulating Data
     
   </span>
   
@@ -10157,18 +10159,18 @@
 </li>
       
         <li class="md-nav__item">
-  <a href="#ipaddress-parenting-concrete-relationship" class="md-nav__link">
+  <a href="#de-duplicating-ipaddresses" class="md-nav__link">
     <span class="md-ellipsis">
-      IPAddress Parenting Concrete Relationship
+      De-duplicating IPAddresses
     </span>
   </a>
   
 </li>
       
         <li class="md-nav__item">
-  <a href="#de-duplicating-ipaddresses" class="md-nav__link">
+  <a href="#repairing-prefix-and-ip-address-hierarchy" class="md-nav__link">
     <span class="md-ellipsis">
-      De-duplicating IPAddresses
+      Repairing Prefix and IP Address Hierarchy
     </span>
   </a>
   
@@ -10194,19 +10196,28 @@
 
 
 <h1 id="ip-addresses">IP Addresses<a class="headerlink" href="#ip-addresses" title="Permanent link">&para;</a></h1>
-<p>An IP address comprises a single host address (either IPv4 or IPv6) and its subnet mask. Its mask should match exactly how the IP address is configured on an interface in the real world.</p>
-<p>IP addresses are automatically arranged under parent prefixes according to the IP hierarchy. IP addresses are not directly assigned to namespaces or VRFs on an individual basis, but instead derive their namespace and VRF(s) from their parent prefix.</p>
+<p>An IP address comprises a single <code>host</code> address (either IPv4 or IPv6) and its associated subnet <code>mask_length</code>, which should match exactly how the IP address is configured on an interface in the real world. For convenience, these two database fields are often available together as a single CIDR <code>address</code> string as well, such as "10.1.2.3/32" (equivalent to <code>host</code> "10.1.2.3" and <code>mask_length</code> 32).</p>
+<div class="admonition tip">
+<p class="admonition-title">Host is immutable</p>
+<p>The <code>host</code> value for a given IP address record cannot be changed once it is created and saved to the database. It is however permissible to change the <code>mask_length</code> as needed. For scenarios such as re-allocation of network space, the recommended workflow is to create a new record for the new <code>host</code> value, then delete the old record.</p>
+</div>
+<p>IP addresses are automatically arranged under their <code>parent</code> <a href="prefix.html">Prefixes</a> according to the IP hierarchy.</p>
+<details class="version-added">
+<summary>Added in version 2.0.0 — IP Address to Prefix is now a concrete foreign-key relationship</summary>
+<p>Parenting of IP addresses under Prefixes is now automatically managed at the database level to greatly improve performance especially when calculating tree hierarchy and utilization. Refer to the <a href="prefix.html">Prefix</a> documentation for more details about this functionality.</p>
+</details>
+<p>IP addresses are not directly assigned to <a href="namespace.html">Namespaces</a> or <a href="vrf.html">VRFs</a> in the database on an individual basis, but instead derive their namespace and VRF(s) from their parent prefix. For convenience, the Nautobot UI, REST API, and Django ORM do present a virtual <code>namespace</code> field on IP addresses, as (especially when creating a new IP address record) it is often more straightforward to specify the <code>namespace</code> of an IP address, and let Nautobot automatically determine the correct <code>parent</code> in that namespace, than to specify the <code>parent</code> directly.</p>
 <details class="version-changed">
-<summary>Changed in version 2.0.0</summary>
+<summary>Changed in version 2.0.0 — All IP addresses must belong to a parent Prefix</summary>
 <p>In Nautobot 1.x, IP addresses were only loosely associated to prefixes, and it was possible to create "orphan" IP addresses that had no corresponding prefix record. In Nautobot 2.0 this is no longer the case; each IP address has a parent prefix, and you can no longer create IP addresses that do not belong to a defined prefix and namespace. When migrating existing data from Nautobot 1.x, parent prefixes will be automatically created where needed, but you may need to do some additional cleanup of your IPAM data after the migration in order to ensure its accuracy and correctness.</p>
 </details>
-<p>Each IP address can also be assigned an operational <a href="../../platform-functionality/status.html"><code>status</code></a> and a functional role.  The following statuses are available by default:</p>
+<p>Each IP address can also be assigned an operational <a href="../../platform-functionality/status.html"><code>status</code></a> and a functional <a href="../../platform-functionality/role.html"><code>role</code></a>.  The following statuses are available by default:</p>
 <ul>
 <li>Active</li>
 <li>Reserved</li>
 <li>Deprecated</li>
 </ul>
-<p>Roles are used to indicate some special attribute of an IP address; for example, use as a loopback or as the the virtual IP for a VRRP group. (Note that functional roles are conceptual in nature, and thus cannot be customized by the user.) Available roles include:</p>
+<p>Roles are used to indicate some special attribute of an IP address; for example, use as a loopback or as the the virtual IP for a VRRP group. The following roles are available by default:</p>
 <ul>
 <li>Loopback</li>
 <li>Secondary</li>
@@ -10223,40 +10234,28 @@
 <li>SLAAC (IPv6 Stateless Address Autoconfiguration)</li>
 </ul>
 <details class="version-changed">
-<summary>Changed in version 2.0.0</summary>
-<p>The relationship to device and virtual machine interfaces has been changed to a many-to-many relationship. This allows an IP address to be assigned to multiple interfaces, and an interface to have multiple IP addresses assigned to it.</p>
+<summary>Changed in version 2.0.0 — One IP Address, multiple interfaces</summary>
+<p>The relationship to device and virtual machine interfaces has been changed to a many-to-many relationship. This allows a single IP address record to be assigned to multiple interfaces simultaneously if desired for scenarios such as IP Anycast.</p>
 </details>
 <p>An IP address can be assigned to device or virtual machine interfaces, and an interface may have multiple IP addresses assigned to it. Further, each device and virtual machine may have one of its interface IPs designated as its primary IP per address family (one for IPv4 and one for IPv6).</p>
 <div class="admonition note">
-<p class="admonition-title">Note</p>
+<p class="admonition-title">Preferring IPv4 or IPv6 primary IPs</p>
 <p>When primary IPs are set for both IPv4 and IPv6, Nautobot will prefer IPv6. This can be changed by setting the <code>PREFER_IPV4</code> configuration parameter.</p>
 </div>
-<details class="version-changed">
-<summary>Changed in version 2.0.0</summary>
-<p><code>prefix_length</code> becomes <code>mask_length</code> and is intended to describe the desired subnet mask of the IP addresses when configured on interface(s).</p>
-</details>
 <h2 id="network-address-translation-nat">Network Address Translation (NAT)<a class="headerlink" href="#network-address-translation-nat" title="Permanent link">&para;</a></h2>
 <p>An IP address can be designated as the network address translation (NAT) inside IP address for one or more other IP addresses. This is useful primarily to denote a translation between public and private IP addresses. This relationship is followed in both directions: For example, if 10.0.0.1 is assigned as the inside IP for 192.0.2.1, 192.0.2.1 will be displayed as the outside IP for 10.0.0.1.</p>
-<h2 id="ipaddress-parenting-concrete-relationship">IPAddress Parenting Concrete Relationship<a class="headerlink" href="#ipaddress-parenting-concrete-relationship" title="Permanent link">&para;</a></h2>
+<h2 id="de-duplicating-ipaddresses">De-duplicating IPAddresses<a class="headerlink" href="#de-duplicating-ipaddresses" title="Permanent link">&para;</a></h2>
 <details class="version-added">
 <summary>Added in version 2.0.0</summary>
 </details>
-<p>The <code>ipam.IPAddress</code> model has been modified to have a foreign key to <code>ipam.Prefix</code> as the <code>parent</code> field. Parenting of IP addresses is now automatically managed at the database level to greatly improve performance especially when calculating tree hierarchy and utilization.</p>
-<p>The following guidance has been added for the <code>IPAddress.parent</code> field:</p>
-<ul>
-<li>An <code>IPAddress</code> should have a parent <code>Prefix</code> of type <code>Network</code></li>
-<li>An <code>IPAddress</code> should not be created if a suitable parent <code>Prefix</code> of type <code>Network</code> does not exist</li>
-<li>An <code>IPAddress</code> can be a member of a <code>Pool</code> but only if the <code>Pool</code> is a child of a <code>Network</code> prefix</li>
-</ul>
-<div class="admonition warning">
-<p class="admonition-title">Warning</p>
-<p>In a future Nautobot release, this guidance will become an enforced constraint on <code>IPAddress</code> creation and modification.</p>
-</div>
-<h2 id="de-duplicating-ipaddresses">De-duplicating IPAddresses<a class="headerlink" href="#de-duplicating-ipaddresses" title="Permanent link">&para;</a></h2>
+<p>In Nautobot 2.0.0 and later, IP Addresses must now be unique per Namespace. As a consequence, data migrations from Nautobot 1.x (where in some cases IP Addresses were permitted to be duplicated) will, as needed, move duplicate IP Addresses to a number of "cleanup" Namespaces in order to avoid uniqueness violations within the global Namespace. In many cases these duplicate IP Address records can be collapsed into single records (in particular, because Nautobot 2.x permits assignment of a single IP Address to multiple Interfaces, whereas Nautobot 1.x did not permit this). To assist with such efforts, Nautobot provides an <a href="../../feature-guides/ip-address-merge-tool.html">IP Address Merge tool</a>.</p>
+<h2 id="repairing-prefix-and-ip-address-hierarchy">Repairing Prefix and IP Address Hierarchy<a class="headerlink" href="#repairing-prefix-and-ip-address-hierarchy" title="Permanent link">&para;</a></h2>
 <details class="version-added">
-<summary>Added in version 2.0.0</summary>
+<summary>Added in version 2.4.17 — Added system Job for repairing incorrect <code>parent</code> values</summary>
 </details>
-<p>After upgrading to Nautobot v2.0, in order to satisfy new uniqueness constraints, the data migrations may duplicate <code>IP Addresses</code> across different <code>Namespaces</code>. Check out this <a href="../../feature-guides/ip-address-merge-tool.html">IP Address Merge tool</a> to collapse unnecessarily duplicated <code>IP Addresses</code>.</p>
+<p>It is possible in some cases, particularly due to insufficient validation in earlier Nautobot 2.x releases, but also due to incorrect logic in custom Jobs and the like, for <code>parent</code> values to become incorrectly set on some IP Address and Prefix records.</p>
+<p>If you encounter or suspect an issue of this sort, Nautobot provides a system <a href="../../platform-functionality/jobs/index.html">Job</a> named "Check/Fix IPAM Parents" which can be run to efficiently detect and repair various problems of this sort.</p>
+<p>If, after running this Job, you later find that this issue recurs, we recommend reviewing any Apps and Jobs that are making programmatic updates to Prefix and IP Address data, as this should not recur during normal Nautobot UI or REST API updates in v2.4.17 and later.</p>
 
 
 
@@ -10346,7 +10345,8 @@
 <!-- RTD version flyout injected on live site -->
 <div id="readthedocs-embed-flyout"></div>
       
-        <div class="md-social">
+        
+<div class="md-social">
   
     
     
@@ -10402,10 +10402,10 @@
     
     
       
-      <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.d50fe291.min.js", "tags": null, "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"}, "version": null}</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.973d3a69.min.js", "tags": null, "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"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.50899def.min.js"></script>
+      <script src="../../../assets/javascripts/bundle.92b07e13.min.js"></script>
       
     
   <script id="init-glightbox">const lightbox = GLightbox({"touchNavigation": true, "loop": false, "zoomable": true, "draggable": true, "openEffect": "zoom", "closeEffect": "zoom", "slideEffect": "slide"});

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

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.18">
     
     
       
@@ -35,6 +35,8 @@
   
   
     
+      
+      
     
   
   
@@ -7449,12 +7451,12 @@
   
   
     <li class="md-nav__item">
-      <a href="../../../development/apps/api/platform-features/populating-extensibility-features.html" class="md-nav__link">
+      <a href="../../../development/apps/api/platform-features/prepopulating-data.html" class="md-nav__link">
         
   
   
   <span class="md-ellipsis">
-    Populating Extensibility Features
+    Prepopulating Data
     
   </span>
   
@@ -10260,7 +10262,8 @@
 <!-- RTD version flyout injected on live site -->
 <div id="readthedocs-embed-flyout"></div>
       
-        <div class="md-social">
+        
+<div class="md-social">
   
     
     
@@ -10316,10 +10319,10 @@
     
     
       
-      <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.d50fe291.min.js", "tags": null, "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"}, "version": null}</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.973d3a69.min.js", "tags": null, "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"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.50899def.min.js"></script>
+      <script src="../../../assets/javascripts/bundle.92b07e13.min.js"></script>
       
     
   <script id="init-glightbox">const lightbox = GLightbox({"touchNavigation": true, "loop": false, "zoomable": true, "draggable": true, "openEffect": "zoom", "closeEffect": "zoom", "slideEffect": "slide"});