PyPI - nautobot - Versions diffs - 2.2.0b1__py3-none-any.whl → 2.2.2__py3-none-any.whl - Mend - Supply Chain Defender

nautobot 2.2.0b1py3-none-any.whl → 2.2.2py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of nautobot might be problematic. Click here for more details.

Files changed (429) hide show

nautobot/project-static/docs/user-guide/core-data-model/dcim/{controllerdevicegroup.html → controllermanageddevicegroup.html} RENAMED Viewed

@@ -8,7 +8,7 @@
-        <link rel="canonical" href="https://docs.nautobot.com/projects/core/en/stable/user-guide/core-data-model/dcim/controllerdevicegroup.html">
+        <link rel="canonical" href="https://docs.nautobot.com/projects/core/en/stable/user-guide/core-data-model/dcim/controllermanageddevicegroup.html">
         <link rel="prev" href="controller.html">
@@ -18,15 +18,15 @@
       <link rel="icon" href="../../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.8">
+      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.16">
-        <title>Controller Device Group - Nautobot Documentation</title>
+        <title>Controller Managed Device Group - Nautobot Documentation</title>
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.f2e4d321.min.css">
+      <link rel="stylesheet" href="../../../assets/stylesheets/main.bcfcd587.min.css">
         <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
@@ -78,7 +78,7 @@
     <div data-md-component="skip">
-        <a href="#controller-device-groups" class="md-skip">
+        <a href="#controller-managed-device-groups" class="md-skip">
           Skip to content
         </a>
@@ -113,7 +113,7 @@
         <div class="md-header__topic" data-md-component="header-topic">
           <span class="md-ellipsis">
-              Controller Device Group
+              Controller Managed Device Group
           </span>
         </div>
@@ -401,16 +401,17 @@
     <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
@@ -449,13 +450,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1" >
@@ -486,13 +488,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_1" >
@@ -688,6 +691,27 @@
+    <li class="md-nav__item">
+      <a href="../../administration/installation/health-checks.html" class="md-nav__link">
+  <span class="md-ellipsis">
+    Health Checks
+  </span>
+      </a>
+    </li>
     <li class="md-nav__item">
       <a href="../../administration/installation/selinux-troubleshooting.html" class="md-nav__link">
@@ -720,13 +744,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_2" >
@@ -799,13 +824,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_2_3" >
@@ -865,13 +891,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_2_3_2" >
@@ -1018,13 +1045,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_3" >
@@ -1105,13 +1133,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_4" >
@@ -1213,13 +1242,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_4_4" >
@@ -1329,13 +1359,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_5" >
@@ -1416,13 +1447,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_6" >
@@ -1637,13 +1669,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_2" >
@@ -1674,13 +1707,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_2_1" >
@@ -1893,7 +1927,7 @@
     <li class="md-nav__item">
-      <a href="../../feature-guides/contact-and-team.html" class="md-nav__link">
+      <a href="../../feature-guides/contacts-and-teams.html" class="md-nav__link">
   <span class="md-ellipsis">
@@ -2052,13 +2086,14 @@
     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_3" checked>
@@ -2089,13 +2124,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_3_1" >
@@ -2155,13 +2191,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_3_2" >
@@ -2307,13 +2344,14 @@
     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_3_3" checked>
@@ -2491,13 +2529,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_3_3_8" >
@@ -2712,13 +2751,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_3_3_9" >
@@ -3171,16 +3211,55 @@
-      <a href="controllerdevicegroup.html" class="md-nav__link md-nav__link--active">
+        <label class="md-nav__link md-nav__link--active" for="__toc">
+  <span class="md-ellipsis">
+    Controller Managed Device Group
+  </span>
+          <span class="md-nav__icon md-icon"></span>
+        </label>
+      <a href="controllermanageddevicegroup.html" class="md-nav__link md-nav__link--active">
   <span class="md-ellipsis">
-    Controller Device Group
+    Controller Managed Device Group
   </span>
       </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="#examples" class="md-nav__link">
+    <span class="md-ellipsis">
+      Examples
+    </span>
+  </a>
+</li>
+    </ul>
+</nav>
     </li>
@@ -3203,13 +3282,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_3_4" >
@@ -3332,13 +3412,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_3_5" >
@@ -3566,13 +3647,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_3_6" >
@@ -3653,13 +3735,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_3_7" >
@@ -3811,13 +3894,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4" >
@@ -4016,13 +4100,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_9" >
@@ -4111,13 +4196,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_11" >
@@ -4311,13 +4397,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_15" >
@@ -4532,13 +4619,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_21" >
@@ -4655,16 +4743,14 @@
-    <li class="md-nav__item md-nav__item--section md-nav__item--nested">
+    <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
@@ -4681,7 +4767,7 @@
             </a>
-              <label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="">
+              <label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
@@ -4703,13 +4789,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_1" >
@@ -4777,13 +4864,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2" >
@@ -4864,13 +4952,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2_3" >
@@ -4980,13 +5069,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2_4" >
@@ -5172,13 +5262,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2_4_8" >
@@ -5288,13 +5379,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2_5" >
@@ -5551,13 +5643,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2_6" >
@@ -5730,13 +5823,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2_8" >
@@ -6258,13 +6352,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2_9" >
@@ -6358,13 +6453,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2_9_4" >
@@ -6495,13 +6591,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2_10" >
@@ -6569,13 +6666,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_3" >
@@ -6780,11 +6878,11 @@
     <li class="md-nav__item">
-      <a href="../../../development/core/extending-models.html" class="md-nav__link">
+      <a href="../../../development/core/generic-views.html" class="md-nav__link">
   <span class="md-ellipsis">
-    Extending Models
+    Generic Views
   </span>
@@ -6801,11 +6899,11 @@
     <li class="md-nav__item">
-      <a href="../../../development/core/generic-views.html" class="md-nav__link">
+      <a href="../../../development/core/homepage.html" class="md-nav__link">
   <span class="md-ellipsis">
-    Generic Views
+    Home Page Panels
   </span>
@@ -6822,11 +6920,11 @@
     <li class="md-nav__item">
-      <a href="../../../development/core/homepage.html" class="md-nav__link">
+      <a href="../../../development/core/model-checklist.html" class="md-nav__link">
   <span class="md-ellipsis">
-    Home Page Panels
+    Model Development Checklist
   </span>
@@ -7049,16 +7147,14 @@
-    <li class="md-nav__item md-nav__item--section md-nav__item--nested">
+    <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
@@ -7075,7 +7171,7 @@
             </a>
-              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
@@ -7314,16 +7410,14 @@
-    <li class="md-nav__item md-nav__item--section md-nav__item--nested">
+    <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
@@ -7340,7 +7434,7 @@
             </a>
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
@@ -7362,13 +7456,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_1" >
@@ -7655,6 +7750,23 @@
+    <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="#examples" class="md-nav__link">
+    <span class="md-ellipsis">
+      Examples
+    </span>
+  </a>
+</li>
+    </ul>
 </nav>
                   </div>
                 </div>
@@ -7671,16 +7783,29 @@
-<h1 id="controller-device-groups">Controller Device Groups<a class="headerlink" href="#controller-device-groups" title="Permanent link">&para;</a></h1>
-<p>A Controller Device Group in Nautobot models the relationship between <a href="controller.html">controllers</a> and the <a href="device.html">devices</a> they manage. It organizes devices under specific controllers, providing a structured way to represent devices controlled by a central network management system. These systems might include, but are not limited to, software-defined networking (SDN) controllers, wireless controllers, and cloud-based network management platforms.</p>
-<p>The relationship between a Controller Device Group, its controllers, and devices is key to managing and visualizing how devices are grouped and controlled. This model allows devices to be categorized into hierarchical groups, making it easier to manage large networks. Each group is directly associated with a Controller, symbolizing the control link between the controller and the devices within the group.</p>
-<p>Key Features:</p>
-<ul>
-<li><strong>Structured Organization:</strong> Facilitates the grouping of devices under specific controllers, simplifying management tasks.</li>
-<li><strong>Flexible Modeling:</strong> Fits various network management scenarios, including SDN controllers, wireless controllers, and cloud-based services.</li>
-<li><strong>Enhanced Management:</strong> Improves the representation of device-controller relationships, aiding in more efficient network management operations.</li>
-</ul>
-<p>For more detailed information about controllers, please refer to the <a href="../../../development/core/controllers.html">developer documentation</a>.</p>
+<h1 id="controller-managed-device-groups">Controller Managed Device Groups<a class="headerlink" href="#controller-managed-device-groups" title="Permanent link">&para;</a></h1>
+<p>A Controller Managed Device Group in Nautobot models the relationship between <a href="controller.html">controllers</a> and the <a href="device.html">devices</a> they manage.</p>
+<p>Each device can be assigned to only one Controller Managed Device Group through the <code>Device.controller_managed_device_group</code> field.</p>
+<p>Similarly, each group is linked directly to a Controller via the <code>ControllerManagedDeviceGroup.controller</code> field. This link represents the control connection between the controller and the devices in the group.</p>
+<p>Groups can be arranged in a hierarchical structure. The <code>ControllerManagedDeviceGroup.parent</code> field is used to depict this tree structure of the controlled devices. To organize child groups within a parent group, use the <code>ControllerManagedDeviceGroup.weight</code> field. All child groups must be assigned to the same controller as the parent group.</p>
+<p>For more detailed information about model relations, please refer to the <a href="../../../development/core/controllers.html">developer documentation</a>.</p>
+<h2 id="examples">Examples<a class="headerlink" href="#examples" title="Permanent link">&para;</a></h2>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nt">controller_managed_device_group</span><span class="p">:</span>
+<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="w">  </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">campus</span>
+<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w">    </span><span class="nt">controller</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Panorama1</span>
+<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="w">    </span><span class="nt">tags</span><span class="p">:</span>
+<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="w">      </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">high_security</span>
+<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="w">    </span><span class="nt">devices</span><span class="p">:</span>
+<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="w">      </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">dal-fw01</span>
+<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="w">      </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">chi-fw01</span>
+<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a><span class="w">  </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">dc</span>
+<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="w">    </span><span class="nt">controller</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Panorama1</span>
+<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a><span class="w">    </span><span class="nt">tags</span><span class="p">:</span>
+<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a><span class="w">      </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">medium_security</span>
+<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a><span class="w">    </span><span class="nt">devices</span><span class="p">:</span>
+<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a><span class="w">      </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">nyc-fw99</span>
+<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a><span class="w">      </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">jcy-fw99</span>
+</code></pre></div>
@@ -7825,9 +7950,9 @@
     <script id="__config" type="application/json">{"base": "../../..", "features": ["content.code.copy", "navigation.footer", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.highlight", "search.share", "search.suggest"], "search": "../../../assets/javascripts/workers/search.b8dbb3d2.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.8fd75fb4.min.js"></script>
+      <script src="../../../assets/javascripts/bundle.bd41221c.min.js"></script>
-        <script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
+        <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
   </body>