nautobot 2.4.3__py3-none-any.whl → 2.4.4__py3-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.
- nautobot/apps/filters.py +2 -0
- nautobot/circuits/filters.py +1 -1
- nautobot/circuits/tests/test_models.py +5 -3
- nautobot/cloud/filters.py +3 -6
- nautobot/cloud/tests/test_filters.py +21 -0
- nautobot/core/admin.py +2 -0
- nautobot/core/jobs/__init__.py +2 -1
- nautobot/core/management/commands/generate_performance_test_endpoints.py +9 -6
- nautobot/core/models/utils.py +6 -1
- nautobot/core/templates/inc/javascript.html +1 -0
- nautobot/core/templatetags/ui_framework.py +20 -4
- nautobot/core/testing/forms.py +1 -1
- nautobot/core/tests/test_api.py +1 -1
- nautobot/core/tests/test_graphql.py +3 -3
- nautobot/core/tests/test_jobs.py +4 -1
- nautobot/core/ui/object_detail.py +1 -1
- nautobot/dcim/api/serializers.py +36 -0
- nautobot/dcim/api/views.py +1 -1
- nautobot/dcim/elevations.py +17 -4
- nautobot/dcim/factory.py +9 -1
- nautobot/dcim/filters/__init__.py +27 -1
- nautobot/dcim/forms.py +13 -1
- nautobot/dcim/models/devices.py +11 -5
- nautobot/dcim/signals.py +26 -0
- nautobot/dcim/templates/dcim/virtualdevicecontext_retrieve.html +0 -62
- nautobot/dcim/templates/dcim/virtualdevicecontext_update.html +6 -0
- nautobot/dcim/tests/test_api.py +176 -0
- nautobot/dcim/tests/test_filters.py +56 -3
- nautobot/dcim/tests/test_models.py +40 -0
- nautobot/dcim/views.py +24 -14
- nautobot/extras/api/mixins.py +1 -1
- nautobot/extras/api/views.py +2 -2
- nautobot/extras/filters/__init__.py +4 -0
- nautobot/extras/models/datasources.py +7 -3
- nautobot/extras/plugins/__init__.py +26 -1
- nautobot/extras/templates/extras/inc/jobresult.html +12 -13
- nautobot/extras/templates/extras/objectchange.html +28 -12
- nautobot/extras/tests/test_api.py +16 -15
- nautobot/extras/tests/test_filters.py +2 -0
- nautobot/extras/tests/test_plugins.py +32 -1
- nautobot/extras/tests/test_views.py +12 -2
- nautobot/extras/views.py +3 -0
- nautobot/ipam/api/serializers.py +7 -8
- nautobot/ipam/api/views.py +2 -2
- nautobot/ipam/factory.py +27 -8
- nautobot/ipam/filters.py +67 -29
- nautobot/ipam/formfields.py +51 -0
- nautobot/ipam/forms.py +13 -1
- nautobot/ipam/migrations/0051_added_optional_vrf_relationship_to_vdc.py +41 -0
- nautobot/ipam/models.py +63 -5
- nautobot/ipam/tables.py +21 -7
- nautobot/ipam/tests/test_api.py +107 -66
- nautobot/ipam/tests/test_filters.py +145 -5
- nautobot/ipam/tests/test_views.py +15 -2
- nautobot/project-static/css/base.css +11 -0
- nautobot/project-static/css/dark.css +2 -1
- nautobot/project-static/docs/code-reference/nautobot/apps/filters.html +62 -0
- nautobot/project-static/docs/development/apps/api/configuration-view.html +0 -3
- nautobot/project-static/docs/development/apps/api/models/graphql.html +0 -4
- nautobot/project-static/docs/development/apps/api/platform-features/custom-validators.html +94 -1
- nautobot/project-static/docs/development/apps/api/platform-features/filter-extensions.html +0 -3
- nautobot/project-static/docs/development/apps/api/platform-features/jinja2-filters.html +0 -3
- nautobot/project-static/docs/development/apps/api/platform-features/populating-extensibility-features.html +0 -3
- nautobot/project-static/docs/development/apps/api/platform-features/secrets-providers.html +0 -3
- nautobot/project-static/docs/development/apps/api/prometheus.html +0 -3
- nautobot/project-static/docs/development/apps/api/testing.html +0 -6
- nautobot/project-static/docs/development/apps/api/ui-extensions/banners.html +0 -3
- nautobot/project-static/docs/development/apps/api/ui-extensions/home-page.html +0 -3
- nautobot/project-static/docs/development/apps/api/ui-extensions/object-views.html +0 -3
- nautobot/project-static/docs/development/apps/api/views/core-view-overrides.html +0 -3
- nautobot/project-static/docs/development/apps/api/views/nautobot-generic-views.html +1 -7
- nautobot/project-static/docs/development/apps/api/views/nautobotuiviewset.html +0 -7
- nautobot/project-static/docs/development/apps/api/views/nautobotuiviewsetrouter.html +0 -4
- nautobot/project-static/docs/development/apps/api/views/notes.html +0 -3
- nautobot/project-static/docs/development/apps/index.html +2 -35
- nautobot/project-static/docs/development/apps/migration/code-updates.html +1 -1
- nautobot/project-static/docs/development/core/application-registry.html +0 -6
- nautobot/project-static/docs/development/core/best-practices.html +0 -27
- nautobot/project-static/docs/development/core/docker-compose-advanced-use-cases.html +58 -4
- nautobot/project-static/docs/development/core/getting-started.html +12 -16
- nautobot/project-static/docs/development/core/homepage.html +0 -3
- nautobot/project-static/docs/development/core/style-guide.html +0 -5
- nautobot/project-static/docs/development/core/templates.html +0 -3
- nautobot/project-static/docs/development/core/testing.html +0 -9
- nautobot/project-static/docs/development/jobs/index.html +3 -29
- nautobot/project-static/docs/objects.inv +0 -0
- nautobot/project-static/docs/overview/application_stack.html +0 -18
- nautobot/project-static/docs/release-notes/version-2.4.html +191 -0
- nautobot/project-static/docs/requirements.txt +1 -1
- nautobot/project-static/docs/search/search_index.json +1 -1
- nautobot/project-static/docs/sitemap.xml +290 -290
- nautobot/project-static/docs/sitemap.xml.gz +0 -0
- nautobot/project-static/docs/user-guide/administration/configuration/settings.html +0 -10
- nautobot/project-static/docs/user-guide/administration/guides/docker.html +0 -15
- nautobot/project-static/docs/user-guide/administration/installation/index.html +0 -16
- nautobot/project-static/docs/user-guide/administration/installation/nautobot.html +1 -4
- nautobot/project-static/docs/user-guide/administration/installation/services.html +0 -11
- nautobot/project-static/docs/user-guide/administration/migration/migrating-from-postgresql.html +3 -3
- nautobot/project-static/docs/user-guide/administration/tools/nautobot-server.html +5 -35
- nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/tables/v2-code-location-changes.yaml +1 -1
- nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/upgrading-from-nautobot-v1.html +1 -1
- nautobot/project-static/docs/user-guide/administration/upgrading/upgrading.html +0 -4
- nautobot/project-static/docs/user-guide/core-data-model/circuits/providernetwork.html +0 -3
- nautobot/project-static/docs/user-guide/core-data-model/dcim/consoleport.html +0 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/consoleporttemplate.html +0 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/consoleserverport.html +0 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/consoleserverporttemplate.html +0 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/devicebay.html +0 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/devicebaytemplate.html +0 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/deviceredundancygroup.html +0 -3
- nautobot/project-static/docs/user-guide/core-data-model/dcim/devicetype.html +0 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/frontport.html +0 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/frontporttemplate.html +0 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/interface.html +1 -17
- nautobot/project-static/docs/user-guide/core-data-model/dcim/interfaceredundancygroup.html +0 -3
- nautobot/project-static/docs/user-guide/core-data-model/dcim/interfacetemplate.html +0 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/inventoryitem.html +0 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/location.html +0 -3
- nautobot/project-static/docs/user-guide/core-data-model/dcim/locationtype.html +1 -7
- nautobot/project-static/docs/user-guide/core-data-model/dcim/platform.html +0 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/poweroutlet.html +0 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/poweroutlettemplate.html +0 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/powerport.html +0 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/powerporttemplate.html +0 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/rearport.html +0 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/rearporttemplate.html +0 -4
- nautobot/project-static/docs/user-guide/core-data-model/extras/configcontext.html +0 -6
- nautobot/project-static/docs/user-guide/core-data-model/extras/configcontextschema.html +0 -3
- nautobot/project-static/docs/user-guide/core-data-model/ipam/ipaddress.html +0 -4
- nautobot/project-static/docs/user-guide/core-data-model/ipam/vlan.html +0 -4
- nautobot/project-static/docs/user-guide/core-data-model/virtualization/vminterface.html +0 -8
- nautobot/project-static/docs/user-guide/feature-guides/custom-fields.html +3 -3
- nautobot/project-static/docs/user-guide/feature-guides/graphql.html +0 -6
- nautobot/project-static/docs/user-guide/platform-functionality/computedfield.html +0 -3
- nautobot/project-static/docs/user-guide/platform-functionality/customfield.html +3 -15
- nautobot/project-static/docs/user-guide/platform-functionality/dynamicgroup.html +0 -26
- nautobot/project-static/docs/user-guide/platform-functionality/gitrepository.html +0 -8
- nautobot/project-static/docs/user-guide/platform-functionality/graphql.html +0 -3
- nautobot/project-static/docs/user-guide/platform-functionality/jobs/index.html +0 -8
- nautobot/project-static/docs/user-guide/platform-functionality/jobs/job-scheduling-and-approvals.html +0 -7
- nautobot/project-static/docs/user-guide/platform-functionality/jobs/jobbutton.html +0 -3
- nautobot/project-static/docs/user-guide/platform-functionality/jobs/jobhook.html +0 -3
- nautobot/project-static/docs/user-guide/platform-functionality/jobs/models.html +0 -14
- nautobot/project-static/docs/user-guide/platform-functionality/note.html +0 -3
- nautobot/project-static/docs/user-guide/platform-functionality/relationship.html +1 -10
- nautobot/project-static/docs/user-guide/platform-functionality/rest-api/authentication.html +0 -3
- nautobot/project-static/docs/user-guide/platform-functionality/rest-api/filtering.html +0 -14
- nautobot/project-static/docs/user-guide/platform-functionality/rest-api/overview.html +0 -19
- nautobot/project-static/docs/user-guide/platform-functionality/secret.html +3 -9
- nautobot/project-static/docs/user-guide/platform-functionality/status.html +0 -8
- nautobot/project-static/docs/user-guide/platform-functionality/tag.html +0 -4
- nautobot/project-static/docs/user-guide/platform-functionality/template-filters.html +1 -13
- nautobot/project-static/docs/user-guide/platform-functionality/webhook.html +0 -5
- nautobot/project-static/js/editor.js +292 -0
- nautobot/project-static/monaco-editor-0.52.2/README.md +81 -0
- nautobot/project-static/monaco-editor-0.52.2/vs/base/browser/ui/codicons/codicon/codicon.ttf +0 -0
- nautobot/project-static/monaco-editor-0.52.2/vs/base/worker/workerMain.js +31 -0
- nautobot/project-static/monaco-editor-0.52.2/vs/basic-languages/xml/xml.js +10 -0
- nautobot/project-static/monaco-editor-0.52.2/vs/basic-languages/yaml/yaml.js +10 -0
- nautobot/project-static/monaco-editor-0.52.2/vs/editor/editor.main.css +8 -0
- nautobot/project-static/monaco-editor-0.52.2/vs/editor/editor.main.js +798 -0
- nautobot/project-static/monaco-editor-0.52.2/vs/language/json/jsonMode.js +19 -0
- nautobot/project-static/monaco-editor-0.52.2/vs/language/json/jsonWorker.js +42 -0
- nautobot/project-static/monaco-editor-0.52.2/vs/loader.js +11 -0
- nautobot/tenancy/filters/__init__.py +3 -5
- nautobot/tenancy/tests/test_filters.py +10 -0
- nautobot/virtualization/views.py +0 -1
- nautobot/wireless/tables.py +9 -4
- nautobot/wireless/tests/test_api.py +0 -9
- {nautobot-2.4.3.dist-info → nautobot-2.4.4.dist-info}/METADATA +2 -2
- {nautobot-2.4.3.dist-info → nautobot-2.4.4.dist-info}/RECORD +175 -163
- {nautobot-2.4.3.dist-info → nautobot-2.4.4.dist-info}/LICENSE.txt +0 -0
- {nautobot-2.4.3.dist-info → nautobot-2.4.4.dist-info}/NOTICE +0 -0
- {nautobot-2.4.3.dist-info → nautobot-2.4.4.dist-info}/WHEEL +0 -0
- {nautobot-2.4.3.dist-info → nautobot-2.4.4.dist-info}/entry_points.txt +0 -0
|
Binary file
|
|
@@ -11431,9 +11431,6 @@
|
|
|
11431
11431
|
<p>This document describes Nautobot-specific configuration settings that may be customized in your <code>nautobot_config.py</code>, or, in many cases, by configuration of appropriate environment variables. It also describes a number of common Django configuration settings that may also be customized similarly.</p>
|
|
11432
11432
|
<p>The <a href="https://docs.djangoproject.com/en/stable/ref/settings/">official Django documentation</a> documents <em>all</em> Django settings, and this document does not attempt to replace that documentation.</p>
|
|
11433
11433
|
<h2 id="administratively-configurable-settings">Administratively Configurable Settings<a class="headerlink" href="#administratively-configurable-settings" title="Permanent link">¶</a></h2>
|
|
11434
|
-
<details class="version-added">
|
|
11435
|
-
<summary>Added in version 1.2.0</summary>
|
|
11436
|
-
</details>
|
|
11437
11434
|
<p>A number of settings can alternatively be configured via the Nautobot Admin UI. To do so, these settings must <strong>not</strong> be defined in your <code>nautobot_config.py</code>, as any settings defined there will take precedence over any values defined in the Admin UI. Settings that are currently configurable via the Admin UI include:</p>
|
|
11438
11435
|
<!-- pyml disable-num-lines 5 blanks-around-lists -->
|
|
11439
11436
|
|
|
@@ -13482,13 +13479,6 @@ in order for the repository to sync.</p>
|
|
|
13482
13479
|
</div>
|
|
13483
13480
|
<hr />
|
|
13484
13481
|
<h3 id="nautobot_log_deprecation_warnings"><code>NAUTOBOT_LOG_DEPRECATION_WARNINGS</code><a class="headerlink" href="#nautobot_log_deprecation_warnings" title="Permanent link">¶</a></h3>
|
|
13485
|
-
<details class="version-added">
|
|
13486
|
-
<summary>Added in version 1.5.2</summary>
|
|
13487
|
-
</details>
|
|
13488
|
-
<details class="version-changed">
|
|
13489
|
-
<summary>Changed in version 1.5.3</summary>
|
|
13490
|
-
<p>This was previously available as a config file setting but changed to environment-variable only. Also <code>DEBUG = True</code> will no longer work to log deprecation warnings.</p>
|
|
13491
|
-
</details>
|
|
13492
13482
|
<p>Default: <code>False</code></p>
|
|
13493
13483
|
<p>This can be set to <code>True</code> to allow deprecation warnings raised by Nautobot to (additionally) be logged as <code>WARNING</code> level log messages. (Deprecation warnings are normally silent in Python, but can be enabled globally by <a href="https://docs.python.org/3/library/warnings.html">various means</a> such as setting the <code>PYTHONWARNINGS</code> environment variable. However, doing so can be rather noisy, as it will also include warnings from within Django about various code in various package dependencies of Nautobot's, etc. This configuration setting allows a more targeted enablement of only warnings from within Nautobot itself, which can be useful when vetting various Nautobot Apps for future-proofness against upcoming changes to Nautobot.)</p>
|
|
13494
13484
|
<hr />
|
|
@@ -9607,10 +9607,6 @@
|
|
|
9607
9607
|
<p>Nautobot is packaged as a Docker image for use in a production environment; developer images are also provided for those working on App development and testing. The Docker image and deployment strategies are being actively developed, check back here or join the <code>#nautobot</code> channel on <a href="https://slack.networktocode.com/">Network to Code's Slack community</a> for the most up to date information.</p>
|
|
9608
9608
|
<h2 id="python-versions">Python Versions<a class="headerlink" href="#python-versions" title="Permanent link">¶</a></h2>
|
|
9609
9609
|
<p>Docker images are published for multiple supported Python versions. The default image, recommended for most users, is based on the <code>python:3.12-slim</code> image.</p>
|
|
9610
|
-
<details class="version-changed">
|
|
9611
|
-
<summary>Changed in version 1.6.1</summary>
|
|
9612
|
-
<p>The Python version for the image tags that do not explicitly state a Python version changed to 3.11 for Nautobot 1.6.1. From now on, these tagged images will always contain the <strong>latest</strong> supported Python version (e.g., when Python 3.12 support is added, these tags will change to contain Python 3.12). This is a change from Nautobot 1.6.0 and earlier, where tags that did not state a Python version would contain the <strong>earliest</strong> supported Python version.</p>
|
|
9613
|
-
</details>
|
|
9614
9610
|
<p>Currently images are pushed for the following Python versions:</p>
|
|
9615
9611
|
<ul>
|
|
9616
9612
|
<li>3.9</li>
|
|
@@ -9619,14 +9615,6 @@
|
|
|
9619
9615
|
<li>3.12</li>
|
|
9620
9616
|
</ul>
|
|
9621
9617
|
<details class="version-added">
|
|
9622
|
-
<summary>Added in version 1.6.0 — Added Python 3.11</summary>
|
|
9623
|
-
<p>Python 3.11 was added to the set of published images.</p>
|
|
9624
|
-
</details>
|
|
9625
|
-
<details class="version-removed">
|
|
9626
|
-
<summary>Removed in version 1.6.0 — Removed Python 3.7</summary>
|
|
9627
|
-
<p>Python 3.7 was removed from the set of published images as Python 3.7 is now end-of-life.</p>
|
|
9628
|
-
</details>
|
|
9629
|
-
<details class="version-added">
|
|
9630
9618
|
<summary>Added in version 2.3.0 — Added Python 3.12</summary>
|
|
9631
9619
|
<p>Python 3.12 was added to the set of published images and is now the default version.</p>
|
|
9632
9620
|
</details>
|
|
@@ -9802,9 +9790,6 @@
|
|
|
9802
9790
|
<h3 id="uwsgi">uWSGI<a class="headerlink" href="#uwsgi" title="Permanent link">¶</a></h3>
|
|
9803
9791
|
<p>The docker container uses <a href="https://uwsgi-docs.readthedocs.io/">uWSGI</a> to serve Nautobot. A default configuration is <a href="https://github.com/nautobot/nautobot/blob/main/docker/uwsgi.ini">provided</a>, and can be overridden by injecting a new <code>uwsgi.ini</code> file at <code>/opt/nautobot/uwsgi.ini</code>. There are a couple of environment variables provided to override some uWSGI defaults:</p>
|
|
9804
9792
|
<h4 id="nautobot_uwsgi_buffer_size"><code>NAUTOBOT_UWSGI_BUFFER_SIZE</code><a class="headerlink" href="#nautobot_uwsgi_buffer_size" title="Permanent link">¶</a></h4>
|
|
9805
|
-
<details class="version-added">
|
|
9806
|
-
<summary>Added in version 1.3.9</summary>
|
|
9807
|
-
</details>
|
|
9808
9793
|
<p>Default: <code>4096</code></p>
|
|
9809
9794
|
<p>Max: <code>65535</code></p>
|
|
9810
9795
|
<p>The max size of non-body request payload, roughly the size of request headers for uWSGI. Request headers that might contain lengthy query parameters, for example GraphQL or Relationship filtered lookups, might go well over the default limit. Increasing this limit will have an impact on running memory usage. Please see <a href="https://uwsgi-docs.readthedocs.io/en/latest/Options.html?highlight=buffer-size#buffer-size">the uWSGI documentation</a> for more information.</p>
|
|
@@ -9374,18 +9374,6 @@
|
|
|
9374
9374
|
<h4 id="python">Python<a class="headerlink" href="#python" title="Permanent link">¶</a></h4>
|
|
9375
9375
|
<p>Nautobot is written in the <a href="https://www.python.org/">Python programming language</a>. The official Python package installer is called <a href="https://pip.pypa.io/en/stable/">Pip</a>, and you will see the <code>pip</code> command referenced often to install or update Python packages.</p>
|
|
9376
9376
|
<details class="version-added">
|
|
9377
|
-
<summary>Added in version 1.3.0 — Python 3.10 support added</summary>
|
|
9378
|
-
<p>Python 3.10 support was added.</p>
|
|
9379
|
-
</details>
|
|
9380
|
-
<details class="version-removed">
|
|
9381
|
-
<summary>Removed in version 1.3.0 — Python 3.6 support removed</summary>
|
|
9382
|
-
<p>Python 3.6 support was removed.</p>
|
|
9383
|
-
</details>
|
|
9384
|
-
<details class="version-changed">
|
|
9385
|
-
<summary>Changed in version 1.6.0 — Python 3.11 support added, Python 3.7 support removed</summary>
|
|
9386
|
-
<p>Python 3.11 support was added and Python 3.7 support was removed.</p>
|
|
9387
|
-
</details>
|
|
9388
|
-
<details class="version-added">
|
|
9389
9377
|
<summary>Added in version 2.3.0 — Python 3.12 support added</summary>
|
|
9390
9378
|
<p>Python 3.12 support was added.</p>
|
|
9391
9379
|
</details>
|
|
@@ -9395,10 +9383,6 @@
|
|
|
9395
9383
|
</details>
|
|
9396
9384
|
<h4 id="database">Database<a class="headerlink" href="#database" title="Permanent link">¶</a></h4>
|
|
9397
9385
|
<p>Nautobot uses a relational database to store its data. Both MySQL and PostgreSQL are officially supported.</p>
|
|
9398
|
-
<details class="version-added">
|
|
9399
|
-
<summary>Added in version 1.1.0 — MySQL support added</summary>
|
|
9400
|
-
<p>MySQL support was added.</p>
|
|
9401
|
-
</details>
|
|
9402
9386
|
<details class="version-removed">
|
|
9403
9387
|
<summary>Removed in version 2.1.0 — PostgreSQL minimum version became 12.0</summary>
|
|
9404
9388
|
<p>Support for versions of PostgreSQL older than 12.0 was removed.</p>
|
|
@@ -9683,10 +9683,7 @@
|
|
|
9683
9683
|
<a id="__codelineno-20-2" name="__codelineno-20-2" href="#__codelineno-20-2"></a>Configuration file created at /opt/nautobot/nautobot_config.py
|
|
9684
9684
|
</code></pre></div>
|
|
9685
9685
|
</details>
|
|
9686
|
-
<
|
|
9687
|
-
<summary>Added in version 1.6.0 — Installation metrics selection</summary>
|
|
9688
|
-
<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="../tools/nautobot-server.html#send_installation_metrics"><code>send_installation_metrics</code></a> command for more information about the feature that this setting toggles.</p>
|
|
9689
|
-
</details>
|
|
9686
|
+
<p>The <code>nautobot-server init</code> command will 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="../tools/nautobot-server.html#send_installation_metrics"><code>send_installation_metrics</code></a> command for more information about the feature that this setting toggles.</p>
|
|
9690
9687
|
<h3 id="required-settings">Required Settings<a class="headerlink" href="#required-settings" title="Permanent link">¶</a></h3>
|
|
9691
9688
|
<p>Your <code>nautobot_config.py</code> provides sane defaults for most configuration settings, but in the longer term, you will inevitably need to update the settings for your environment. For a more complete guide to supported configuration settings in Nautobot, you can refer to <a href="../configuration/settings.html">Settings</a> later.</p>
|
|
9692
9689
|
<div class="admonition tip">
|
|
@@ -9539,10 +9539,6 @@
|
|
|
9539
9539
|
<p>Nautobot requires at least one worker to consume background tasks required for advanced background features. A <code>nautobot-server celery</code> command is included that directly invokes Celery. This command behaves exactly as the Celery command-line utility does, but launches it through Nautobot's environment to share Redis and database connection settings transparently.</p>
|
|
9540
9540
|
<div class="highlight"><span class="filename">Show help for the Nautobot worker service</span><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>nautobot-server celery --help
|
|
9541
9541
|
</code></pre></div>
|
|
9542
|
-
<details class="version-changed">
|
|
9543
|
-
<summary>Changed in version 1.1.0 — Celery added to Nautobot</summary>
|
|
9544
|
-
<p>Prior to version 1.1.0, Nautobot utilized RQ as the primary background task worker. As of Nautobot 1.1.0, RQ is now <em>deprecated</em>. RQ and the <code>@job</code> decorator for custom tasks were still supported for the remainder of the 1.x.y releases, but users should <a href="#migrating-to-celery-from-rq">migrate the primary worker to Celery</a>.</p>
|
|
9545
|
-
</details>
|
|
9546
9542
|
<details class="version-removed">
|
|
9547
9543
|
<summary>Removed in version 2.0.0 — RQ removed from Nautobot</summary>
|
|
9548
9544
|
<p>Support for RQ has been completely removed from Nautobot.</p>
|
|
@@ -9677,10 +9673,6 @@ documentation</a> for the available configuration parameters.</p>
|
|
|
9677
9673
|
<h3 id="nautobot-background-services">Nautobot Background Services<a class="headerlink" href="#nautobot-background-services" title="Permanent link">¶</a></h3>
|
|
9678
9674
|
<p>Next, we will setup the <code>systemd</code> units for the Celery worker and Celery Beat scheduler.</p>
|
|
9679
9675
|
<h4 id="celery-worker">Celery Worker<a class="headerlink" href="#celery-worker" title="Permanent link">¶</a></h4>
|
|
9680
|
-
<details class="version-added">
|
|
9681
|
-
<summary>Added in version 1.1.0 — Celery added to Nautobot</summary>
|
|
9682
|
-
<p>Prior to version 1.1.0, Nautobot utilized RQ as the primary background task worker. As of Nautobot 1.1.0, RQ is now <em>deprecated</em> and has been replaced with Celery. RQ and the <code>@job</code> decorator for custom tasks were still supported for the remainder of the 1.x.y releases, but users should <a href="#migrating-to-celery-from-rq">migrate the primary worker to Celery</a>.</p>
|
|
9683
|
-
</details>
|
|
9684
9676
|
<p>The Celery worker service consumes tasks from background task queues and is required for taking advantage of advanced
|
|
9685
9677
|
Nautobot features including <a href="../../platform-functionality/jobs/index.html">Jobs</a>, <a href="../../platform-functionality/customfield.html">Custom
|
|
9686
9678
|
Fields</a>, and <a href="../../platform-functionality/gitrepository.html">Git Repositories</a>, among others.</p>
|
|
@@ -9722,9 +9714,6 @@ Fields</a>, and <a href="../../platform-functionality/gitrepository.html">Git Re
|
|
|
9722
9714
|
<a id="__codelineno-10-23" name="__codelineno-10-23" href="#__codelineno-10-23"></a><span class="na">WantedBy</span><span class="o">=</span><span class="s">multi-user.target</span>
|
|
9723
9715
|
</code></pre></div>
|
|
9724
9716
|
<h4 id="celery-beat-scheduler">Celery Beat Scheduler<a class="headerlink" href="#celery-beat-scheduler" title="Permanent link">¶</a></h4>
|
|
9725
|
-
<details class="version-added">
|
|
9726
|
-
<summary>Added in version 1.2.0 — Celery Beat added to Nautobot</summary>
|
|
9727
|
-
</details>
|
|
9728
9717
|
<p>The Celery Beat scheduler enables the periodic execution of and scheduling of background tasks. It is required to take advantage of the <a href="../../platform-functionality/jobs/job-scheduling-and-approvals.html">job scheduling and approval</a> features.</p>
|
|
9729
9718
|
<div class="admonition warning">
|
|
9730
9719
|
<p class="admonition-title">Warning</p>
|
nautobot/project-static/docs/user-guide/administration/migration/migrating-from-postgresql.html
CHANGED
|
@@ -9308,14 +9308,14 @@
|
|
|
9308
9308
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> --traceback \
|
|
9309
9309
|
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> > nautobot_dump.json
|
|
9310
9310
|
</code></pre></div>
|
|
9311
|
-
<
|
|
9312
|
-
<
|
|
9311
|
+
<div class="admonition warning">
|
|
9312
|
+
<p class="admonition-title">Warning</p>
|
|
9313
9313
|
<ul>
|
|
9314
9314
|
<li>We do not recommend at this time using <code>--natural-primary</code> as this can result in inconsistent or incorrect data for data models that use GenericForeignKeys, such as <code>Cable</code>, <code>Note</code>, <code>ObjectChange</code>, and <code>Tag</code>.</li>
|
|
9315
9315
|
<li>We also do not recommend at this time using <code>--natural-foreign</code> as it can potentially result in errors if any data models incorrectly implement their <code>natural_key()</code> and/or <code>get_by_natural_key()</code> API methods.</li>
|
|
9316
9316
|
<li><code>contenttypes</code> must not be excluded from the dump (it could be excluded previously due to the use of <code>--natural-foreign</code>).</li>
|
|
9317
9317
|
</ul>
|
|
9318
|
-
</
|
|
9318
|
+
</div>
|
|
9319
9319
|
<div class="admonition warning">
|
|
9320
9320
|
<p class="admonition-title">Warning</p>
|
|
9321
9321
|
<p>Because of the different SQL dialects used by PostgreSQL and MySQL, Django's JSON database dump format is being used as the go-between for migrating your database contents from the one system to the other. This is a different case than general database backup and recovery; for best practices there, please refer to <a href="../upgrading/database-backup.html">Database Backup</a>.</p>
|
|
@@ -9892,21 +9892,14 @@
|
|
|
9892
9892
|
<p>This is a built-in Django command. Please see the <a href="https://docs.djangoproject.com/en/stable/ref/django-admin/#dbshell">official documentation on <code>dbshell</code></a> for more information.</p>
|
|
9893
9893
|
</div>
|
|
9894
9894
|
<h3 id="dumpdata"><code>dumpdata</code><a class="headerlink" href="#dumpdata" title="Permanent link">¶</a></h3>
|
|
9895
|
-
<
|
|
9896
|
-
<
|
|
9897
|
-
<ul>
|
|
9898
|
-
<li><code>extras.job</code> should now be included in the dump (removed <code>--exclude extras.job</code> from the example usage)</li>
|
|
9899
|
-
<li><code>django_rq</code> should now be excluded from the dump (added <code>--exclude django_rq</code> to the example usage)</li>
|
|
9900
|
-
</ul>
|
|
9901
|
-
</details>
|
|
9902
|
-
<details class="version-changed">
|
|
9903
|
-
<summary>Changed in version 1.5.23</summary>
|
|
9895
|
+
<div class="admonition warning">
|
|
9896
|
+
<p class="admonition-title">Warning</p>
|
|
9904
9897
|
<ul>
|
|
9905
|
-
<li>We do not recommend
|
|
9906
|
-
<li>We also do not recommend
|
|
9898
|
+
<li>We do not recommend using <code>--natural-primary</code> as this can result in inconsistent or incorrect data for data models that use GenericForeignKeys, such as <code>Cable</code>, <code>Note</code>, <code>ObjectChange</code>, and <code>Tag</code>.</li>
|
|
9899
|
+
<li>We also do not recommend using <code>--natural-foreign</code> as it can potentially result in errors if any data models incorrectly implement their <code>natural_key()</code> and/or <code>get_by_natural_key()</code> API methods.</li>
|
|
9907
9900
|
<li><code>contenttypes</code> must not be excluded from the dump (it could be excluded previously due to the use of <code>--natural-foreign</code>).</li>
|
|
9908
9901
|
</ul>
|
|
9909
|
-
</
|
|
9902
|
+
</div>
|
|
9910
9903
|
<details class="version-changed">
|
|
9911
9904
|
<summary>Changed in version 2.0.0</summary>
|
|
9912
9905
|
<ul>
|
|
@@ -9957,9 +9950,6 @@
|
|
|
9957
9950
|
<div class="highlight"><pre><span></span><code><a id="__codelineno-22-1" name="__codelineno-22-1" href="#__codelineno-22-1"></a>e!j=vrlhz-!wl8p_3+q5s5cph29nzj$xm81eap-!&n!_9^du09
|
|
9958
9951
|
</code></pre></div>
|
|
9959
9952
|
<h3 id="generate_test_data"><code>generate_test_data</code><a class="headerlink" href="#generate_test_data" title="Permanent link">¶</a></h3>
|
|
9960
|
-
<details class="version-added">
|
|
9961
|
-
<summary>Added in version 1.5.0</summary>
|
|
9962
|
-
</details>
|
|
9963
9953
|
<p><code>nautobot-server generate_test_data [--flush] --seed SEED</code></p>
|
|
9964
9954
|
<p>Populate the database with various data as a baseline for testing (automated or manual).</p>
|
|
9965
9955
|
<p><code>--flush</code><br />
|
|
@@ -10010,10 +10000,6 @@ String to use as a random generator seed for reproducible results.</p>
|
|
|
10010
10000
|
<a id="__codelineno-28-4" name="__codelineno-28-4" href="#__codelineno-28-4"></a>Installation metrics will be sent when running 'nautobot-server post_upgrade'. Thank you!
|
|
10011
10001
|
<a id="__codelineno-28-5" name="__codelineno-28-5" href="#__codelineno-28-5"></a>Configuration file created at /home/example/.nautobot/nautobot_config.py
|
|
10012
10002
|
</code></pre></div>
|
|
10013
|
-
<details class="version-added">
|
|
10014
|
-
<summary>Added in version 1.6.0</summary>
|
|
10015
|
-
<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>
|
|
10016
|
-
</details>
|
|
10017
10003
|
<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>
|
|
10018
10004
|
<h3 id="loaddata"><code>loaddata</code><a class="headerlink" href="#loaddata" title="Permanent link">¶</a></h3>
|
|
10019
10005
|
<p><code>nautobot-server loaddata --traceback nautobot_dump.json</code></p>
|
|
@@ -10081,10 +10067,6 @@ String to use as a random generator seed for reproducible results.</p>
|
|
|
10081
10067
|
<p><code>nautobot-server post_upgrade</code></p>
|
|
10082
10068
|
<p>Performs common server post-upgrade operations using a single entrypoint.</p>
|
|
10083
10069
|
<p>This will run the following management commands with default settings, in order:</p>
|
|
10084
|
-
<details class="version-changed">
|
|
10085
|
-
<summary>Changed in version 1.6.0</summary>
|
|
10086
|
-
<p>Added the <a href="#send_installation_metrics"><code>send_installation_metrics</code></a> command to the list of commands run by <code>post_upgrade</code>.</p>
|
|
10087
|
-
</details>
|
|
10088
10070
|
<ul>
|
|
10089
10071
|
<li><code>migrate</code></li>
|
|
10090
10072
|
<li><code>trace_paths</code></li>
|
|
@@ -10161,21 +10143,12 @@ Do not automatically refresh the dynamic group member lists.</p>
|
|
|
10161
10143
|
<a id="__codelineno-34-23" name="__codelineno-34-23" href="#__codelineno-34-23"></a>Removing expired sessions...
|
|
10162
10144
|
</code></pre></div>
|
|
10163
10145
|
<h3 id="refresh_dynamic_group_member_caches"><code>refresh_dynamic_group_member_caches</code><a class="headerlink" href="#refresh_dynamic_group_member_caches" title="Permanent link">¶</a></h3>
|
|
10164
|
-
<details class="version-added">
|
|
10165
|
-
<summary>Added in version 1.6.0</summary>
|
|
10166
|
-
</details>
|
|
10167
10146
|
<p><code>nautobot-server refresh_dynamic_group_member_caches</code></p>
|
|
10168
10147
|
<p>Refresh the cached members of all Dynamic Groups. This can also be achieved by running the <code>Refresh Dynamic Group Caches</code> system Job.</p>
|
|
10169
10148
|
<h3 id="refresh_content_type_caches"><code>refresh_content_type_caches</code><a class="headerlink" href="#refresh_content_type_caches" title="Permanent link">¶</a></h3>
|
|
10170
|
-
<details class="version-added">
|
|
10171
|
-
<summary>Added in version 1.6.0</summary>
|
|
10172
|
-
</details>
|
|
10173
10149
|
<p><code>nautobot-server refresh_content_type_caches</code></p>
|
|
10174
10150
|
<p>Refresh the cached ContentType object property available via <code>Model._content_type_cached</code>. If content types are added or removed, this command will update the cache to reflect the current state of the database, but should already be done through the <code>post_upgrade</code> command.</p>
|
|
10175
10151
|
<h3 id="remove_stale_scheduled_jobs"><code>remove_stale_scheduled_jobs</code><a class="headerlink" href="#remove_stale_scheduled_jobs" title="Permanent link">¶</a></h3>
|
|
10176
|
-
<details class="version-added">
|
|
10177
|
-
<summary>Added in version 1.3.10</summary>
|
|
10178
|
-
</details>
|
|
10179
10152
|
<p><code>nautobot-server remove_stale_scheduled_jobs [max-age of days]</code></p>
|
|
10180
10153
|
<p>Delete non-recurring scheduled jobs that were scheduled to run more than <code>max-age</code> days ago.</p>
|
|
10181
10154
|
<h3 id="renaturalize"><code>renaturalize</code><a class="headerlink" href="#renaturalize" title="Permanent link">¶</a></h3>
|
|
@@ -10231,9 +10204,6 @@ JSON string that populates the <code>data</code> variable of the job.</p>
|
|
|
10231
10204
|
</code></pre></div>
|
|
10232
10205
|
<p>Please see the <a href="../../platform-functionality/jobs/index.html">guide on Jobs</a> for more information on working with and running jobs.</p>
|
|
10233
10206
|
<h3 id="send_installation_metrics"><code>send_installation_metrics</code><a class="headerlink" href="#send_installation_metrics" title="Permanent link">¶</a></h3>
|
|
10234
|
-
<details class="version-added">
|
|
10235
|
-
<summary>Added in version 1.6.0</summary>
|
|
10236
|
-
</details>
|
|
10237
10207
|
<p><code>nautobot-server send_installation_metrics</code></p>
|
|
10238
10208
|
<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>
|
|
10239
10209
|
<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>
|
|
@@ -135,7 +135,7 @@
|
|
|
135
135
|
Class/Function(s): "dynamic_import"
|
|
136
136
|
New Module: "nautobot.core.api.utils"
|
|
137
137
|
- Old Module: "nautobot.utilities.utils"
|
|
138
|
-
Class/Function(s): "
|
|
138
|
+
Class/Function(s): "ensure_content_type_and_field_name_in_query_params"
|
|
139
139
|
New Module: "nautobot.core.utils.requests"
|
|
140
140
|
- Old Module: "nautobot.utilities.utils"
|
|
141
141
|
Class/Function(s): "flatten_dict"
|
|
@@ -13948,7 +13948,7 @@ Most removed database fields in Nautobot 2.0 fall into the following general cat
|
|
|
13948
13948
|
</tr>
|
|
13949
13949
|
<tr>
|
|
13950
13950
|
<td>nautobot.utilities.utils</td>
|
|
13951
|
-
<td>
|
|
13951
|
+
<td>ensure_content_type_and_field_name_in_query_params</td>
|
|
13952
13952
|
<td>nautobot.core.utils.requests</td>
|
|
13953
13953
|
</tr>
|
|
13954
13954
|
<tr>
|
|
@@ -9479,10 +9479,6 @@ release notes under the release in which the change went into effect.</p>
|
|
|
9479
9479
|
</tbody>
|
|
9480
9480
|
</table>
|
|
9481
9481
|
<details class="version-removed">
|
|
9482
|
-
<summary>Removed in version 1.6.0</summary>
|
|
9483
|
-
<p>Support for Python 3.7 was removed.</p>
|
|
9484
|
-
</details>
|
|
9485
|
-
<details class="version-removed">
|
|
9486
9482
|
<summary>Removed in version 2.1.0</summary>
|
|
9487
9483
|
<p>Support for versions of PostgreSQL older than 12.0 was removed.</p>
|
|
9488
9484
|
</details>
|
|
@@ -9122,9 +9122,6 @@
|
|
|
9122
9122
|
|
|
9123
9123
|
|
|
9124
9124
|
<h1 id="provider-network">Provider Network<a class="headerlink" href="#provider-network" title="Permanent link">¶</a></h1>
|
|
9125
|
-
<details class="version-added">
|
|
9126
|
-
<summary>Added in version 1.3.0</summary>
|
|
9127
|
-
</details>
|
|
9128
9125
|
<p>A provider network represents an abstract portion of network topology, just like in a topology diagram. For example, a provider network may be used to represent a provider's MPLS network.</p>
|
|
9129
9126
|
<p>Each provider network must be assigned to a provider. A circuit may terminate to either a provider network or to a valid location.</p>
|
|
9130
9127
|
|
|
@@ -9136,10 +9136,6 @@
|
|
|
9136
9136
|
<h1 id="console-ports">Console Ports<a class="headerlink" href="#console-ports" title="Permanent link">¶</a></h1>
|
|
9137
9137
|
<p>A console port provides connectivity to the physical console of a device. These are typically used for temporary access by someone who is physically near the device, or for remote out-of-band access provided via a networked console server. Each console port may be assigned a physical type.</p>
|
|
9138
9138
|
<p>Cables can connect console ports to console server ports or pass-through ports.</p>
|
|
9139
|
-
<details class="version-added">
|
|
9140
|
-
<summary>Added in version 1.4.5</summary>
|
|
9141
|
-
<p>The fields <code>created</code> and <code>last_updated</code> were added to all device component models. If you upgraded from Nautobot 1.4.4 or earlier, the values for these fields will default to <code>None</code> (null).</p>
|
|
9142
|
-
</details>
|
|
9143
9139
|
<details class="version-changed">
|
|
9144
9140
|
<summary>Changed in version 2.3.0</summary>
|
|
9145
9141
|
<p>This model has been updated to support being installed in <a href="module.html">Modules</a>. As a result, there are now two fields for assignment to a Device or Module. One of the <code>device</code> or <code>module</code> fields must be populated but not both. If a <code>module</code> is supplied, the <code>device</code> field must be null, and similarly the <code>module</code> field must be null if a <code>device</code> is supplied.</p>
|
|
@@ -9135,10 +9135,6 @@
|
|
|
9135
9135
|
|
|
9136
9136
|
<h1 id="console-port-templates">Console Port Templates<a class="headerlink" href="#console-port-templates" title="Permanent link">¶</a></h1>
|
|
9137
9137
|
<p>A template for a console port that will be created on all instantiations of the parent device type. Each console port can be assigned a physical type.</p>
|
|
9138
|
-
<details class="version-added">
|
|
9139
|
-
<summary>Added in version 1.4.5</summary>
|
|
9140
|
-
<p>The fields <code>created</code> and <code>last_updated</code> were added to all device component template models. If you upgraded from Nautobot 1.4.4 or earlier, the values for these fields will default to <code>None</code> (null).</p>
|
|
9141
|
-
</details>
|
|
9142
9138
|
<details class="version-changed">
|
|
9143
9139
|
<summary>Changed in version 2.3.0</summary>
|
|
9144
9140
|
<p>This model has been updated to support being installed in <a href="module.html">Modules</a> through the <a href="moduletype.html">ModuleType</a> model. As a result, there are now two fields for assignment to a DeviceType or ModuleType. One of the <code>device_type</code> or <code>module_type</code> fields must be populated but not both. If a <code>module_type</code> is supplied, the <code>device_type</code> field must be null, and similarly the <code>module_type</code> field must be null if a <code>device_type</code> is supplied.</p>
|
|
@@ -9136,10 +9136,6 @@
|
|
|
9136
9136
|
<h1 id="console-server-ports">Console Server Ports<a class="headerlink" href="#console-server-ports" title="Permanent link">¶</a></h1>
|
|
9137
9137
|
<p>A console server is a device which provides remote access to the local consoles of connected devices. They are typically used to provide remote out-of-band access to network devices. Each console server port may be assigned a physical type.</p>
|
|
9138
9138
|
<p>Cables can connect console server ports to console ports or pass-through ports.</p>
|
|
9139
|
-
<details class="version-added">
|
|
9140
|
-
<summary>Added in version 1.4.5</summary>
|
|
9141
|
-
<p>The fields <code>created</code> and <code>last_updated</code> were added to all device component models. If you upgraded from Nautobot 1.4.4 or earlier, the values for these fields will default to <code>None</code> (null).</p>
|
|
9142
|
-
</details>
|
|
9143
9139
|
<details class="version-changed">
|
|
9144
9140
|
<summary>Changed in version 2.3.0</summary>
|
|
9145
9141
|
<p>This model has been updated to support being installed in <a href="module.html">Modules</a>. As a result, there are now two fields for assignment to a Device or Module. One of the <code>device</code> or <code>module</code> fields must be populated but not both. If a <code>module</code> is supplied, the <code>device</code> field must be null, and similarly the <code>module</code> field must be null if a <code>device</code> is supplied.</p>
|
|
@@ -9135,10 +9135,6 @@
|
|
|
9135
9135
|
|
|
9136
9136
|
<h1 id="console-server-port-templates">Console Server Port Templates<a class="headerlink" href="#console-server-port-templates" title="Permanent link">¶</a></h1>
|
|
9137
9137
|
<p>A template for a console server port that will be created on all instantiations of the parent device type. Each console server port can be assigned a physical type.</p>
|
|
9138
|
-
<details class="version-added">
|
|
9139
|
-
<summary>Added in version 1.4.5</summary>
|
|
9140
|
-
<p>The fields <code>created</code> and <code>last_updated</code> were added to all device component template models. If you upgraded from Nautobot 1.4.4 or earlier, the values for these fields will default to <code>None</code> (null).</p>
|
|
9141
|
-
</details>
|
|
9142
9138
|
<details class="version-changed">
|
|
9143
9139
|
<summary>Changed in version 2.3.0</summary>
|
|
9144
9140
|
<p>This model has been updated to support being installed in <a href="module.html">Modules</a> through the <a href="moduletype.html">ModuleType</a> model. As a result, there are now two fields for assignment to a DeviceType or ModuleType. One of the <code>device_type</code> or <code>module_type</code> fields must be populated but not both. If a <code>module_type</code> is supplied, the <code>device_type</code> field must be null, and similarly the <code>module_type</code> field must be null if a <code>device_type</code> is supplied.</p>
|
|
@@ -9130,10 +9130,6 @@
|
|
|
9130
9130
|
<summary>Changed in version 2.3.0</summary>
|
|
9131
9131
|
<p>Device bays are <strong>not</strong> suitable for modeling line cards (such as those commonly found in chassis-based routers and switches), as these components depend on the control plane of the parent device to operate. Previously, it was recommended that line cards and similarly non-autonomous hardware should be modeled as inventory items within a device, but as of version 2.3.0 the <a href="module.html">Module</a> model should be used instead.</p>
|
|
9132
9132
|
</details>
|
|
9133
|
-
<details class="version-added">
|
|
9134
|
-
<summary>Added in version 1.4.5</summary>
|
|
9135
|
-
<p>The fields <code>created</code> and <code>last_updated</code> were added to all device component models. If you upgraded from Nautobot 1.4.4 or earlier, the values for these fields will default to <code>None</code> (null).</p>
|
|
9136
|
-
</details>
|
|
9137
9133
|
|
|
9138
9134
|
|
|
9139
9135
|
|
|
@@ -9125,10 +9125,6 @@
|
|
|
9125
9125
|
|
|
9126
9126
|
<h1 id="device-bay-templates">Device Bay Templates<a class="headerlink" href="#device-bay-templates" title="Permanent link">¶</a></h1>
|
|
9127
9127
|
<p>A template for a device bay that will be created on all instantiations of the parent device type.</p>
|
|
9128
|
-
<details class="version-added">
|
|
9129
|
-
<summary>Added in version 1.4.5</summary>
|
|
9130
|
-
<p>The fields <code>created</code> and <code>last_updated</code> were added to all device component template models. If you upgraded from Nautobot 1.4.4 or earlier, the values for these fields will default to <code>None</code> (null).</p>
|
|
9131
|
-
</details>
|
|
9132
9128
|
|
|
9133
9129
|
|
|
9134
9130
|
|
|
@@ -9328,9 +9328,6 @@
|
|
|
9328
9328
|
|
|
9329
9329
|
|
|
9330
9330
|
<h1 id="device-redundancy-groups">Device Redundancy Groups<a class="headerlink" href="#device-redundancy-groups" title="Permanent link">¶</a></h1>
|
|
9331
|
-
<details class="version-added">
|
|
9332
|
-
<summary>Added in version 1.5.0</summary>
|
|
9333
|
-
</details>
|
|
9334
9331
|
<p>Device Redundancy Groups represent logical relationships between multiple devices. Typically, a redundancy group could represent a failover pair, failover group, or a load sharing cluster.
|
|
9335
9332
|
Device Redundancy Groups are created first, before the devices are assigned to the group.</p>
|
|
9336
9333
|
<p>A failover strategy represents intended operation mode of the group. Supported failover strategy are: Active/Active and Active/Standby.</p>
|
|
@@ -9144,10 +9144,6 @@
|
|
|
9144
9144
|
<p>This parent/child relationship is <strong>not</strong> suitable for modeling chassis-based devices, wherein child members share a common control plane. Instead, line cards and similarly non-autonomous hardware should be modeled as inventory items within a device, with any associated interfaces or other components assigned directly to the device.</p>
|
|
9145
9145
|
</div>
|
|
9146
9146
|
<h2 id="device-component-templates">Device Component Templates<a class="headerlink" href="#device-component-templates" title="Permanent link">¶</a></h2>
|
|
9147
|
-
<details class="version-added">
|
|
9148
|
-
<summary>Added in version 1.4.5</summary>
|
|
9149
|
-
<p>The fields <code>created</code> and <code>last_updated</code> were added to all device component template models. If you upgraded from Nautobot 1.4.4 or earlier, the values for these fields will default to <code>None</code> (null).</p>
|
|
9150
|
-
</details>
|
|
9151
9147
|
<p>Each device type is assigned a number of component templates which define the physical components within a device. These are:</p>
|
|
9152
9148
|
<ul>
|
|
9153
9149
|
<li>Console ports</li>
|
|
@@ -9135,10 +9135,6 @@
|
|
|
9135
9135
|
|
|
9136
9136
|
<h1 id="front-ports">Front Ports<a class="headerlink" href="#front-ports" title="Permanent link">¶</a></h1>
|
|
9137
9137
|
<p>Front ports are pass-through ports used to represent physical cable connections that comprise part of a longer path. For example, the ports on the front face of a UTP patch panel would be modeled in Nautobot as front ports. Each port is assigned a physical type, and must be mapped to a specific rear port on the same device. A single rear port may be mapped to multiple rear ports, using numeric positions to annotate the specific alignment of each.</p>
|
|
9138
|
-
<details class="version-added">
|
|
9139
|
-
<summary>Added in version 1.4.5</summary>
|
|
9140
|
-
<p>The fields <code>created</code> and <code>last_updated</code> were added to all device component models. If you upgraded from Nautobot 1.4.4 or earlier, the values for these fields will default to <code>None</code> (null).</p>
|
|
9141
|
-
</details>
|
|
9142
9138
|
<details class="version-changed">
|
|
9143
9139
|
<summary>Changed in version 2.3.0</summary>
|
|
9144
9140
|
<p>This model has been updated to support being installed in <a href="module.html">Modules</a>. As a result, there are now two fields for assignment to a Device or Module. One of the <code>device</code> or <code>module</code> fields must be populated but not both. If a <code>module</code> is supplied, the <code>device</code> field must be null, and similarly the <code>module</code> field must be null if a <code>device</code> is supplied.</p>
|
|
@@ -9135,10 +9135,6 @@
|
|
|
9135
9135
|
|
|
9136
9136
|
<h1 id="front-port-templates">Front Port Templates<a class="headerlink" href="#front-port-templates" title="Permanent link">¶</a></h1>
|
|
9137
9137
|
<p>A template for a front-facing pass-through port that will be created on all instantiations of the parent device type. Front ports may have a physical type assigned, and must be associated with a corresponding rear port and position. This association will be automatically replicated when the device type is instantiated.</p>
|
|
9138
|
-
<details class="version-added">
|
|
9139
|
-
<summary>Added in version 1.4.5</summary>
|
|
9140
|
-
<p>The fields <code>created</code> and <code>last_updated</code> were added to all device component template models. If you upgraded from Nautobot 1.4.4 or earlier, the values for these fields will default to <code>None</code> (null).</p>
|
|
9141
|
-
</details>
|
|
9142
9138
|
<details class="version-changed">
|
|
9143
9139
|
<summary>Changed in version 2.3.0</summary>
|
|
9144
9140
|
<p>This model has been updated to support being installed in <a href="module.html">Modules</a> through the <a href="moduletype.html">ModuleType</a> model. As a result, there are now two fields for assignment to a DeviceType or ModuleType. One of the <code>device_type</code> or <code>module_type</code> fields must be populated but not both. If a <code>module_type</code> is supplied, the <code>device_type</code> field must be null, and similarly the <code>module_type</code> field must be null if a <code>device_type</code> is supplied.</p>
|
|
@@ -9143,16 +9143,8 @@
|
|
|
9143
9143
|
<li>Decommissioning</li>
|
|
9144
9144
|
<li>Failed</li>
|
|
9145
9145
|
</ul>
|
|
9146
|
-
<details class="version-added">
|
|
9147
|
-
<summary>Added in version 1.4.0</summary>
|
|
9148
|
-
<ul>
|
|
9149
|
-
<li>Added <code>bridge</code> field.</li>
|
|
9150
|
-
<li>Added <code>parent_interface</code> field.</li>
|
|
9151
|
-
<li>Added <code>status</code> field.</li>
|
|
9152
|
-
</ul>
|
|
9153
|
-
</details>
|
|
9154
9146
|
<p>Interfaces may be physical or virtual in nature, but only physical interfaces may be connected via cables. Cables can connect interfaces to pass-through ports, circuit terminations, or other interfaces.</p>
|
|
9155
|
-
<p>Physical interfaces may be arranged into a link aggregation group (LAG) and associated with a parent LAG (virtual) interface. LAG interfaces can be recursively nested to model bonding of trunk groups. Like all virtual interfaces, LAG interfaces cannot be connected physically.</p>
|
|
9147
|
+
<p>Physical interfaces may be arranged into a link aggregation group (LAG) and associated with a parent LAG (virtual) interface. LAG interfaces can be recursively nested to model bonding of trunk groups. Like all virtual interfaces, LAG interfaces cannot be connected physically. Interfaces can be assigned to an <a href="interfaceredundancygroup.html">Interface Redundancy Group</a> to represent redundancy protocols such as HSRP or VRRP.</p>
|
|
9156
9148
|
<details class="version-changed">
|
|
9157
9149
|
<summary>Changed in version 2.0.0</summary>
|
|
9158
9150
|
<p>The relationship to IP addresses 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>
|
|
@@ -9163,14 +9155,6 @@
|
|
|
9163
9155
|
<p>Although devices and virtual machines both can have interfaces, a separate model is used for each. Thus, device interfaces have some properties that are not present on virtual machine interfaces and vice versa.</p>
|
|
9164
9156
|
</div>
|
|
9165
9157
|
<details class="version-added">
|
|
9166
|
-
<summary>Added in version 1.4.5</summary>
|
|
9167
|
-
<p>The fields <code>created</code> and <code>last_updated</code> were added to all device component models. If you upgraded from Nautobot 1.4.4 or earlier, the values for these fields will default to <code>None</code> (null).</p>
|
|
9168
|
-
</details>
|
|
9169
|
-
<details class="version-added">
|
|
9170
|
-
<summary>Added in version 1.6.0</summary>
|
|
9171
|
-
<p>Interfaces can now be assigned to an <a href="interfaceredundancygroup.html">Interface Redundancy Group</a> to represent redundancy protocols such as HSRP or VRRP.</p>
|
|
9172
|
-
</details>
|
|
9173
|
-
<details class="version-added">
|
|
9174
9158
|
<summary>Added in version 2.3.0</summary>
|
|
9175
9159
|
<p>Interfaces now have an optional <code>role</code> field and can be assigned <a href="../../platform-functionality/role.html">Role</a> instances to track common configurations.</p>
|
|
9176
9160
|
</details>
|
|
@@ -9196,9 +9196,6 @@
|
|
|
9196
9196
|
|
|
9197
9197
|
|
|
9198
9198
|
<h1 id="interface-redundancy-groups">Interface Redundancy Groups<a class="headerlink" href="#interface-redundancy-groups" title="Permanent link">¶</a></h1>
|
|
9199
|
-
<details class="version-added">
|
|
9200
|
-
<summary>Added in version 1.6.0</summary>
|
|
9201
|
-
</details>
|
|
9202
9199
|
<p>Interface Redundancy Groups represent groups of interfaces that share a single virtual address. This model is intended to represent redundancy protocols such as HSRP or VRRP that allow multiple devices to provide a fault-tolerant default gateway for a network.</p>
|
|
9203
9200
|
<p>Interface Redundancy Groups must be created before interfaces can be assigned to the group.</p>
|
|
9204
9201
|
<div class="admonition note">
|
|
@@ -9135,10 +9135,6 @@
|
|
|
9135
9135
|
|
|
9136
9136
|
<h1 id="interface-templates">Interface Templates<a class="headerlink" href="#interface-templates" title="Permanent link">¶</a></h1>
|
|
9137
9137
|
<p>A template for a network interface that will be created on all instantiations of the parent device type or module type. Each interface may be assigned a physical or virtual type, and may be designated as "management-only."</p>
|
|
9138
|
-
<details class="version-added">
|
|
9139
|
-
<summary>Added in version 1.4.5</summary>
|
|
9140
|
-
<p>The fields <code>created</code> and <code>last_updated</code> were added to all device component template models. If you upgraded from Nautobot 1.4.4 or earlier, the values for these fields will default to <code>None</code> (null).</p>
|
|
9141
|
-
</details>
|
|
9142
9138
|
<details class="version-changed">
|
|
9143
9139
|
<summary>Changed in version 2.3.0</summary>
|
|
9144
9140
|
<p>This model has been updated to support being installed in <a href="module.html">Modules</a> through the <a href="moduletype.html">ModuleType</a> model. As a result, there are now two fields for assignment to a DeviceType or ModuleType. One of the <code>device_type</code> or <code>module_type</code> fields must be populated but not both. If a <code>module_type</code> is supplied, the <code>device_type</code> field must be null, and similarly the <code>module_type</code> field must be null if a <code>device_type</code> is supplied.</p>
|
|
@@ -9142,10 +9142,6 @@
|
|
|
9142
9142
|
<p>Unless a specific use case is identified for inventory items, they are likely to be completely replaced by <a href="module.html">Modules</a> and removed in a future release of Nautobot.</p>
|
|
9143
9143
|
</div>
|
|
9144
9144
|
<details class="version-added">
|
|
9145
|
-
<summary>Added in version 1.4.5</summary>
|
|
9146
|
-
<p>The fields <code>created</code> and <code>last_updated</code> were added to all device component models. If you upgraded from Nautobot 1.4.4 or earlier, the values for these fields will default to <code>None</code> (null).</p>
|
|
9147
|
-
</details>
|
|
9148
|
-
<details class="version-added">
|
|
9149
9145
|
<summary>Added in version 2.2.0</summary>
|
|
9150
9146
|
<p>The <a href="softwareversion.html">Software Version</a> model has been introduced to represent the software version that is currently installed on an inventory item. An optional software version field has been added to inventory items.</p>
|
|
9151
9147
|
</details>
|
|
@@ -9122,9 +9122,6 @@
|
|
|
9122
9122
|
|
|
9123
9123
|
|
|
9124
9124
|
<h1 id="locations">Locations<a class="headerlink" href="#locations" title="Permanent link">¶</a></h1>
|
|
9125
|
-
<details class="version-added">
|
|
9126
|
-
<summary>Added in version 1.4.0</summary>
|
|
9127
|
-
</details>
|
|
9128
9125
|
<p>To locate network information more precisely than a Site defines, you can define a hierarchy of Locations within each Site. Data objects such as devices, prefixes, VLAN groups, etc. can thus be mapped or assigned to a specific building, wing, floor, room, etc. as appropriate to your needs.</p>
|
|
9129
9126
|
<p>Once you have defined the hierarchy of Location Types that you wish to use, you can then define Locations. Any "top-level" Locations (those whose Location Type has no parent) belong directly to a Site, while "child" Locations belong to their immediate parent Location, rather than to the Site as a whole.</p>
|
|
9130
9127
|
<div class="admonition info">
|
|
@@ -9122,14 +9122,9 @@
|
|
|
9122
9122
|
|
|
9123
9123
|
|
|
9124
9124
|
<h1 id="location-types">Location Types<a class="headerlink" href="#location-types" title="Permanent link">¶</a></h1>
|
|
9125
|
-
<details class="version-added">
|
|
9126
|
-
<summary>Added in version 1.4.0</summary>
|
|
9127
|
-
</details>
|
|
9128
9125
|
<p>Before defining individual Locations, you must first define the hierarchy of Location Types that you wish to use for the organization of your network. An example hierarchy might be <code>Building ← Floor ← Room</code>, but you might have more or fewer distinct types depending on your specific organizational requirements.</p>
|
|
9129
9126
|
<p>Each Location Type can define a set of "content types" that are permitted to associate to Locations of this type. For example, you might permit assigning Prefixes and VLAN Groups to an entire Building or Floor, but only allow Devices and Racks to be assigned to Rooms, never to a more abstract location. Doing so can help ensure consistency of your data.</p>
|
|
9130
|
-
<
|
|
9131
|
-
<summary>Added in version 1.5.0</summary>
|
|
9132
|
-
<p>Location Types can now be marked as <code>nestable</code>. When this flag is set, Locations of this type may nest within one another, allowing for variable-depth hierarchies of Locations and reducing the number of distinct Location Types you may need to define. For example, with two Location Types, "Building Group" and "Building", by flagging "Building Group" as nestable, you could model the following hierarchy of Locations:</p>
|
|
9127
|
+
<p>Location Types can be marked as <code>nestable</code>. When this flag is set, Locations of this type may nest within one another, allowing for variable-depth hierarchies of Locations and reducing the number of distinct Location Types you may need to define. For example, with two Location Types, "Building Group" and "Building", by flagging "Building Group" as nestable, you could model the following hierarchy of Locations:</p>
|
|
9133
9128
|
<ul>
|
|
9134
9129
|
<li>Main Campus (Building Group)<ul>
|
|
9135
9130
|
<li>West Campus (Building Group)<ul>
|
|
@@ -9160,7 +9155,6 @@
|
|
|
9160
9155
|
</ul>
|
|
9161
9156
|
</li>
|
|
9162
9157
|
</ul>
|
|
9163
|
-
</details>
|
|
9164
9158
|
<div class="admonition tip">
|
|
9165
9159
|
<p class="admonition-title">Tip</p>
|
|
9166
9160
|
<p>Although it is possible to define a "tree" of Location Types with multiple "branches", in the majority of cases doing so adds more unnecessary complexity than it's worth. Consider the following hypothetical Location Type tree:</p>
|
|
@@ -9126,10 +9126,6 @@
|
|
|
9126
9126
|
<p>Platforms may optionally be limited by manufacturer: If a platform is assigned to a particular manufacturer, it can only be assigned to devices with a type belonging to that manufacturer.</p>
|
|
9127
9127
|
<p>The platform model can be used to indicate which "network driver" Nautobot (and Jobs, Apps, etc.) should use when connecting to a remote device running this platform. This is a generic string corresponding loosely to a <a href="https://github.com/ktbyers/netmiko">Netmiko</a> driver name. As there are many different libraries and applications for connecting to a device, rather than having a separate model field for each such connection type, Nautobot uses <a href="https://netutils.readthedocs.io/en/latest/">netutils</a> to translate the generic network driver string into a variety of library-specific driver strings (Ansible "collection name", PyATS "OS" value, Scrapli "platform", etc.) which can be accessed via the UI, REST API, and GraphQL as needed. An administrator can extend or override the default translations provided by netutils by configuring the <a href="../../administration/configuration/settings.html#network_drivers"><code>NETWORK_DRIVERS</code></a> dictionary appropriately. (If your extensions are generally applicable, please consider making a pull request against <a href="https://github.com/networktocode/netutils">netutils</a> to update the package!)</p>
|
|
9128
9128
|
<details class="version-added">
|
|
9129
|
-
<summary>Added in version 1.6.0</summary>
|
|
9130
|
-
<p>The <code>network_driver</code> database field and the <code>network_driver_mappings</code> derived property were added to the Platform data model. Support for the <code>NETWORK_DRIVERS</code> setting was added.</p>
|
|
9131
|
-
</details>
|
|
9132
|
-
<details class="version-added">
|
|
9133
9129
|
<summary>Added in version 2.0.0</summary>
|
|
9134
9130
|
<p>Support for <code>netutils_parser</code> key was added to <code>network_driver_mappings</code>.</p>
|
|
9135
9131
|
</details>
|
|
@@ -9232,10 +9232,6 @@
|
|
|
9232
9232
|
<p>Power outlets represent the outlets on a power distribution unit (PDU) or other device that supply power to dependent devices. Each power port may be assigned a physical type, and may be associated with a specific feed leg (where three-phase power is used) and/or a specific upstream power port. This association can be used to model the distribution of power within a device.</p>
|
|
9233
9233
|
<p>For example, imagine a PDU with one power port which draws from a three-phase feed and 48 power outlets arranged into three banks of 16 outlets each. Outlets 1-16 would be associated with leg A on the port, and outlets 17-32 and 33-48 would be associated with legs B and C, respectively.</p>
|
|
9234
9234
|
<p>Cables can connect power outlets only to downstream power ports. (Pass-through ports cannot be used to model power distribution.)</p>
|
|
9235
|
-
<details class="version-added">
|
|
9236
|
-
<summary>Added in version 1.4.5</summary>
|
|
9237
|
-
<p>The fields <code>created</code> and <code>last_updated</code> were added to all device component models. If you upgraded from Nautobot 1.4.4 or earlier, the values for these fields will default to <code>None</code> (null).</p>
|
|
9238
|
-
</details>
|
|
9239
9235
|
<details class="version-changed">
|
|
9240
9236
|
<summary>Changed in version 2.3.0</summary>
|
|
9241
9237
|
<p>This model has been updated to support being installed in <a href="module.html">Modules</a>. As a result, there are now two fields for assignment to a Device or Module. One of the <code>device</code> or <code>module</code> fields must be populated but not both. If a <code>module</code> is supplied, the <code>device</code> field must be null, and similarly the <code>module</code> field must be null if a <code>device</code> is supplied.</p>
|