nautobot 2.3.3__py3-none-any.whl → 2.3.4__py3-none-any.whl

nautobot/project-static/docs/user-guide/administration/tools/nautobot-server.html

@@ -790,7 +790,7 @@
             
   
   <span class="md-ellipsis">
-    Installation Extras
+    Upgrading
   </span>
   
 
@@ -799,115 +799,6 @@
         
         <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_1_2_label" aria-expanded="false">
           <label class="md-nav__title" for="__nav_2_1_2">
-            <span class="md-nav__icon md-icon"></span>
-            Installation Extras
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../installation-extras/docker.html" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    Nautobot Docker Images
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../installation-extras/health-checks.html" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    Health Checks
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../installation-extras/selinux-troubleshooting.html" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    SELinux Troubleshooting
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_3" >
-        
-          
-          <label class="md-nav__link" for="__nav_2_1_3" id="__nav_2_1_3_label" tabindex="0">
-            
-  
-  <span class="md-ellipsis">
-    Upgrading
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_1_3_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_1_3">
             <span class="md-nav__icon md-icon"></span>
             Upgrading
           </label>
@@ -972,7 +863,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_3_3" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_2_3" >
         
           
           
@@ -988,14 +879,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_2_1_3_3" id="__nav_2_1_3_3_label" tabindex="0">
+              <label class="md-nav__link " for="__nav_2_1_2_3" id="__nav_2_1_2_3_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_2_1_3_3_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_1_3_3">
+        <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_2_1_2_3_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_1_2_3">
             <span class="md-nav__icon md-icon"></span>
             Upgrading Nautobot from v1.X to v2.0
           </label>
@@ -1039,7 +930,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_3_3_2" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_2_3_2" >
         
           
           
@@ -1055,14 +946,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_2_1_3_3_2" id="__nav_2_1_3_3_2_label" tabindex="0">
+              <label class="md-nav__link " for="__nav_2_1_2_3_2" id="__nav_2_1_2_3_2_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="5" aria-labelledby="__nav_2_1_3_3_2_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_1_3_3_2">
+        <nav class="md-nav" data-md-level="5" aria-labelledby="__nav_2_1_2_3_2_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_1_2_3_2">
             <span class="md-nav__icon md-icon"></span>
             IPAM Migration Guide
           </label>
@@ -1193,10 +1084,10 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_4" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_3" >
         
           
-          <label class="md-nav__link" for="__nav_2_1_4" id="__nav_2_1_4_label" tabindex="0">
+          <label class="md-nav__link" for="__nav_2_1_3" id="__nav_2_1_3_label" tabindex="0">
             
   
   <span class="md-ellipsis">
@@ -1207,8 +1098,8 @@
             <span class="md-nav__icon md-icon"></span>
           </label>
         
-        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_1_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_1_4">
+        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_1_3_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_1_3">
             <span class="md-nav__icon md-icon"></span>
             Migration
           </label>
@@ -1281,7 +1172,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_5" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_4" >
         
           
           
@@ -1297,14 +1188,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_2_1_5" id="__nav_2_1_5_label" tabindex="0">
+              <label class="md-nav__link " for="__nav_2_1_4" id="__nav_2_1_4_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_1_5_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_1_5">
+        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_1_4_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_1_4">
             <span class="md-nav__icon md-icon"></span>
             Configuration
           </label>
@@ -1317,11 +1208,11 @@
   
   
     <li class="md-nav__item">
-      <a href="../configuration/required-settings.html" class="md-nav__link">
+      <a href="../configuration/settings.html" class="md-nav__link">
         
   
   <span class="md-ellipsis">
-    Required Settings
+    Settings
   </span>
   
 
@@ -1338,11 +1229,11 @@
   
   
     <li class="md-nav__item">
-      <a href="../configuration/optional-settings.html" class="md-nav__link">
+      <a href="../configuration/redis.html" class="md-nav__link">
         
   
   <span class="md-ellipsis">
-    Optional Settings
+    Redis
   </span>
   
 
@@ -1390,10 +1281,10 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_5_4" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_4_4" >
         
           
-          <label class="md-nav__link" for="__nav_2_1_5_4" id="__nav_2_1_5_4_label" tabindex="0">
+          <label class="md-nav__link" for="__nav_2_1_4_4" id="__nav_2_1_4_4_label" tabindex="0">
             
   
   <span class="md-ellipsis">
@@ -1404,8 +1295,8 @@
             <span class="md-nav__icon md-icon"></span>
           </label>
         
-        <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_2_1_5_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_1_5_4">
+        <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_2_1_4_4_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_1_4_4">
             <span class="md-nav__icon md-icon"></span>
             External Authentication
           </label>
@@ -1509,10 +1400,10 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_6" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_5" checked>
         
           
-          <label class="md-nav__link" for="__nav_2_1_6" id="__nav_2_1_6_label" tabindex="0">
+          <label class="md-nav__link" for="__nav_2_1_5" id="__nav_2_1_5_label" tabindex="0">
             
   
   <span class="md-ellipsis">
@@ -1523,8 +1414,8 @@
             <span class="md-nav__icon md-icon"></span>
           </label>
         
-        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_1_6_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_2_1_6">
+        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_1_5_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_2_1_5">
             <span class="md-nav__icon md-icon"></span>
             Tools
           </label>
@@ -1922,10 +1813,10 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_7" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_6" >
         
           
-          <label class="md-nav__link" for="__nav_2_1_7" id="__nav_2_1_7_label" tabindex="0">
+          <label class="md-nav__link" for="__nav_2_1_6" id="__nav_2_1_6_label" tabindex="0">
             
   
   <span class="md-ellipsis">
@@ -1936,8 +1827,8 @@
             <span class="md-nav__icon md-icon"></span>
           </label>
         
-        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_1_7_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_1_7">
+        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_1_6_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_1_6">
             <span class="md-nav__icon md-icon"></span>
             Guides
           </label>
@@ -1950,11 +1841,32 @@
   
   
     <li class="md-nav__item">
-      <a href="../guides/caching.html" class="md-nav__link">
+      <a href="../guides/docker.html" class="md-nav__link">
         
   
   <span class="md-ellipsis">
-    Caching
+    Nautobot Docker Images
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../guides/selinux-troubleshooting.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    SELinux Troubleshooting
   </span>
   
 
@@ -1971,11 +1883,11 @@
   
   
     <li class="md-nav__item">
-      <a href="../guides/healthcheck.html" class="md-nav__link">
+      <a href="../guides/health-checks.html" class="md-nav__link">
         
   
   <span class="md-ellipsis">
-    Health Check
+    Health Checks
   </span>
   
 
@@ -9390,7 +9302,7 @@
 </div>
 <h3 id="collectstatic"><code>collectstatic</code><a class="headerlink" href="#collectstatic" title="Permanent link">&para;</a></h3>
 <p><code>nautobot-server collectstatic</code></p>
-<p>Collect static files into <a href="../configuration/optional-settings.html#static_root"><code>STATIC_ROOT</code></a>.</p>
+<p>Collect static files into <a href="../configuration/settings.html#static_root"><code>STATIC_ROOT</code></a>.</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a>nautobot-server collectstatic
 </code></pre></div>
 <p>Output:</p>
@@ -9498,7 +9410,7 @@
 </code></pre></div>
 <h3 id="generate_secret_key"><code>generate_secret_key</code><a class="headerlink" href="#generate_secret_key" title="Permanent link">&para;</a></h3>
 <p><code>nautobot-server generate_secret_key</code></p>
-<p>Generates a new <a href="../configuration/required-settings.html#secret_key"><code>SECRET_KEY</code></a> that can be used in your <code>nautobot_config.py</code>:</p>
+<p>Generates a new <a href="../configuration/settings.html#secret_key"><code>SECRET_KEY</code></a> that can be used in your <code>nautobot_config.py</code>:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-21-1" name="__codelineno-21-1" href="#__codelineno-21-1"></a>nautobot-server generate_secret_key
 </code></pre></div>
 <p>Output:</p>
@@ -9544,10 +9456,10 @@ String to use as a random generator seed for reproducible results.</p>
 <a id="__codelineno-26-2" name="__codelineno-26-2" href="#__codelineno-26-2"></a>DefaultFileStorageHealthCheck ... working
 <a id="__codelineno-26-3" name="__codelineno-26-3" href="#__codelineno-26-3"></a>RedisBackend             ... working
 </code></pre></div>
-<p>Please see the <a href="../guides/healthcheck.html">healthcheck documentation</a> for more information.</p>
+<p>Please see the <a href="../guides/health-checks.html">health-checks documentation</a> for more information.</p>
 <h3 id="init"><code>init</code><a class="headerlink" href="#init" title="Permanent link">&para;</a></h3>
 <p><code>nautobot-server init [--disable-installation-metrics] [config_path]</code></p>
-<p>Generates a new configuration with all of the default settings provided for you, and will also generate a unique <a href="../configuration/required-settings.html#secret_key"><code>SECRET_KEY</code></a>.</p>
+<p>Generates a new configuration with all of the default settings provided for you, and will also generate a unique <a href="../configuration/settings.html#secret_key"><code>SECRET_KEY</code></a>.</p>
 <p>By default the file will be created at <code>$HOME/.nautobot/nautobot_config.py</code>:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-27-1" name="__codelineno-27-1" href="#__codelineno-27-1"></a>nautobot-server init
 </code></pre></div>
@@ -9560,7 +9472,7 @@ String to use as a random generator seed for reproducible results.</p>
 </code></pre></div>
 <details class="version-added">
 <summary>Added in version 1.6.0</summary>
-<p>The <code>nautobot-server init</code> command will now prompt you to set the initial value for the <a href="../configuration/optional-settings.html#installation_metrics_enabled"><code>INSTALLATION_METRICS_ENABLED</code></a> setting. See the <a href="#send_installation_metrics">send_installation_metrics</a> command for more information about the feature that this setting toggles.</p>
+<p>The <code>nautobot-server init</code> command will now prompt you to set the initial value for the <a href="../configuration/settings.html#installation_metrics_enabled"><code>INSTALLATION_METRICS_ENABLED</code></a> setting. See the <a href="#send_installation_metrics"><code>send_installation_metrics</code></a> command for more information about the feature that this setting toggles.</p>
 </details>
 <p>For more information on configuring Nautobot for the first time or on more advanced configuration patterns, please see the guide on <a href="../configuration/index.html">Nautobot Configuration</a>.</p>
 <h3 id="loaddata"><code>loaddata</code><a class="headerlink" href="#loaddata" title="Permanent link">&para;</a></h3>
@@ -9817,7 +9729,7 @@ JSON string that populates the <code>data</code> variable of the job.</p>
 </details>
 <p><code>nautobot-server send_installation_metrics</code></p>
 <p>Send anonymized installation metrics to the Nautobot maintainers. This management command is called by <a href="#post_upgrade"><code>post_upgrade</code></a> and is not intended to be run manually.</p>
-<p>If the <a href="../configuration/optional-settings.html#installation_metrics_enabled"><code>INSTALLATION_METRICS_ENABLED</code></a> setting is <code>True</code>, this command will send a list of all installed <a href="../../../development/apps/index.html">Apps</a> and their versions, as well as the currently installed Nautobot and Python versions, to the Nautobot maintainers. A randomized UUID will be generated and saved in the <a href="../configuration/optional-settings.html#deployment_id"><code>DEPLOYMENT_ID</code></a> setting to anonymously but uniquely identify this installation. The App names will be one-way hashed with SHA256 to further anonymize the data sent. This enables tracking the installation metrics of publicly released apps without disclosing the names of any private apps.</p>
+<p>If the <a href="../configuration/settings.html#installation_metrics_enabled"><code>INSTALLATION_METRICS_ENABLED</code></a> setting is <code>True</code>, this command will send a list of all installed <a href="../../../development/apps/index.html">Apps</a> and their versions, as well as the currently installed Nautobot and Python versions, to the Nautobot maintainers. A randomized UUID will be generated and saved in the <a href="../configuration/settings.html#deployment_id"><code>DEPLOYMENT_ID</code></a> setting to anonymously but uniquely identify this installation. The App names will be one-way hashed with SHA256 to further anonymize the data sent. This enables tracking the installation metrics of publicly released apps without disclosing the names of any private apps.</p>
 <p>The following is an example of the data that is sent:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-41-1" name="__codelineno-41-1" href="#__codelineno-41-1"></a><span class="p">{</span>
 <a id="__codelineno-41-2" name="__codelineno-41-2" href="#__codelineno-41-2"></a>    <span class="s2">&quot;deployment_id&quot;</span><span class="p">:</span> <span class="s2">&quot;1de3dacf-f046-4a98-8d4a-17419080db79&quot;</span><span class="p">,</span>