nautobot 2.3.5__py3-none-any.whl → 2.3.6__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/core/api/utils.py +12 -2
- nautobot/core/forms/fields.py +5 -2
- nautobot/core/forms/utils.py +31 -6
- nautobot/core/models/fields.py +56 -0
- nautobot/core/tests/test_utils.py +83 -0
- nautobot/dcim/tests/test_api.py +4 -1
- nautobot/extras/factory.py +2 -1
- nautobot/extras/models/models.py +2 -0
- nautobot/extras/tests/test_api.py +3 -3
- nautobot/extras/tests/test_forms.py +2 -0
- nautobot/extras/tests/test_views.py +2 -2
- nautobot/ipam/api/serializers.py +30 -1
- nautobot/ipam/api/views.py +165 -3
- nautobot/ipam/filters.py +1 -1
- nautobot/ipam/forms.py +2 -0
- nautobot/ipam/migrations/0050_vlangroup_range.py +24 -0
- nautobot/ipam/models.py +51 -8
- nautobot/ipam/tables.py +4 -4
- nautobot/ipam/templates/ipam/vlangroup.html +4 -0
- nautobot/ipam/tests/test_api.py +174 -0
- nautobot/ipam/tests/test_models.py +35 -1
- nautobot/ipam/tests/test_utils.py +61 -0
- nautobot/ipam/tests/test_views.py +2 -0
- nautobot/ipam/utils/__init__.py +10 -17
- nautobot/ipam/views.py +1 -1
- nautobot/project-static/docs/code-reference/nautobot/apps/forms.html +2 -2
- nautobot/project-static/docs/development/apps/api/models/index.html +2 -2
- nautobot/project-static/docs/objects.inv +0 -0
- nautobot/project-static/docs/release-notes/version-2.3.html +218 -72
- nautobot/project-static/docs/search/search_index.json +1 -1
- nautobot/project-static/docs/sitemap.xml +269 -269
- nautobot/project-static/docs/sitemap.xml.gz +0 -0
- nautobot/project-static/docs/user-guide/core-data-model/ipam/vlangroup.html +305 -0
- {nautobot-2.3.5.dist-info → nautobot-2.3.6.dist-info}/METADATA +1 -1
- {nautobot-2.3.5.dist-info → nautobot-2.3.6.dist-info}/RECORD +39 -37
- {nautobot-2.3.5.dist-info → nautobot-2.3.6.dist-info}/LICENSE.txt +0 -0
- {nautobot-2.3.5.dist-info → nautobot-2.3.6.dist-info}/NOTICE +0 -0
- {nautobot-2.3.5.dist-info → nautobot-2.3.6.dist-info}/WHEEL +0 -0
- {nautobot-2.3.5.dist-info → nautobot-2.3.6.dist-info}/entry_points.txt +0 -0
|
Binary file
|
|
@@ -4292,6 +4292,17 @@
|
|
|
4292
4292
|
|
|
4293
4293
|
|
|
4294
4294
|
|
|
4295
|
+
<label class="md-nav__link md-nav__link--active" for="__toc">
|
|
4296
|
+
|
|
4297
|
+
|
|
4298
|
+
<span class="md-ellipsis">
|
|
4299
|
+
VLAN Group
|
|
4300
|
+
</span>
|
|
4301
|
+
|
|
4302
|
+
|
|
4303
|
+
<span class="md-nav__icon md-icon"></span>
|
|
4304
|
+
</label>
|
|
4305
|
+
|
|
4295
4306
|
<a href="vlangroup.html" class="md-nav__link md-nav__link--active">
|
|
4296
4307
|
|
|
4297
4308
|
|
|
@@ -4302,6 +4313,76 @@
|
|
|
4302
4313
|
|
|
4303
4314
|
</a>
|
|
4304
4315
|
|
|
4316
|
+
|
|
4317
|
+
|
|
4318
|
+
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
|
4319
|
+
|
|
4320
|
+
|
|
4321
|
+
|
|
4322
|
+
|
|
4323
|
+
|
|
4324
|
+
|
|
4325
|
+
<label class="md-nav__title" for="__toc">
|
|
4326
|
+
<span class="md-nav__icon md-icon"></span>
|
|
4327
|
+
Table of contents
|
|
4328
|
+
</label>
|
|
4329
|
+
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
4330
|
+
|
|
4331
|
+
<li class="md-nav__item">
|
|
4332
|
+
<a href="#vlan-group-ranges" class="md-nav__link">
|
|
4333
|
+
<span class="md-ellipsis">
|
|
4334
|
+
VLAN Group Ranges
|
|
4335
|
+
</span>
|
|
4336
|
+
</a>
|
|
4337
|
+
|
|
4338
|
+
</li>
|
|
4339
|
+
|
|
4340
|
+
<li class="md-nav__item">
|
|
4341
|
+
<a href="#creating-new-vlans-in-a-vlangroup-programatically" class="md-nav__link">
|
|
4342
|
+
<span class="md-ellipsis">
|
|
4343
|
+
Creating new VLANs in a VLANGroup programatically
|
|
4344
|
+
</span>
|
|
4345
|
+
</a>
|
|
4346
|
+
|
|
4347
|
+
<nav class="md-nav" aria-label="Creating new VLANs in a VLANGroup programatically">
|
|
4348
|
+
<ul class="md-nav__list">
|
|
4349
|
+
|
|
4350
|
+
<li class="md-nav__item">
|
|
4351
|
+
<a href="#creating-vlangroup-example" class="md-nav__link">
|
|
4352
|
+
<span class="md-ellipsis">
|
|
4353
|
+
Creating VLANGroup example
|
|
4354
|
+
</span>
|
|
4355
|
+
</a>
|
|
4356
|
+
|
|
4357
|
+
</li>
|
|
4358
|
+
|
|
4359
|
+
<li class="md-nav__item">
|
|
4360
|
+
<a href="#listing-available-vlans-example" class="md-nav__link">
|
|
4361
|
+
<span class="md-ellipsis">
|
|
4362
|
+
Listing available VLANs example
|
|
4363
|
+
</span>
|
|
4364
|
+
</a>
|
|
4365
|
+
|
|
4366
|
+
</li>
|
|
4367
|
+
|
|
4368
|
+
<li class="md-nav__item">
|
|
4369
|
+
<a href="#creating-new-vlans-example" class="md-nav__link">
|
|
4370
|
+
<span class="md-ellipsis">
|
|
4371
|
+
Creating new VLANs example
|
|
4372
|
+
</span>
|
|
4373
|
+
</a>
|
|
4374
|
+
|
|
4375
|
+
</li>
|
|
4376
|
+
|
|
4377
|
+
</ul>
|
|
4378
|
+
</nav>
|
|
4379
|
+
|
|
4380
|
+
</li>
|
|
4381
|
+
|
|
4382
|
+
</ul>
|
|
4383
|
+
|
|
4384
|
+
</nav>
|
|
4385
|
+
|
|
4305
4386
|
</li>
|
|
4306
4387
|
|
|
4307
4388
|
|
|
@@ -8565,6 +8646,65 @@
|
|
|
8565
8646
|
|
|
8566
8647
|
|
|
8567
8648
|
|
|
8649
|
+
<label class="md-nav__title" for="__toc">
|
|
8650
|
+
<span class="md-nav__icon md-icon"></span>
|
|
8651
|
+
Table of contents
|
|
8652
|
+
</label>
|
|
8653
|
+
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
8654
|
+
|
|
8655
|
+
<li class="md-nav__item">
|
|
8656
|
+
<a href="#vlan-group-ranges" class="md-nav__link">
|
|
8657
|
+
<span class="md-ellipsis">
|
|
8658
|
+
VLAN Group Ranges
|
|
8659
|
+
</span>
|
|
8660
|
+
</a>
|
|
8661
|
+
|
|
8662
|
+
</li>
|
|
8663
|
+
|
|
8664
|
+
<li class="md-nav__item">
|
|
8665
|
+
<a href="#creating-new-vlans-in-a-vlangroup-programatically" class="md-nav__link">
|
|
8666
|
+
<span class="md-ellipsis">
|
|
8667
|
+
Creating new VLANs in a VLANGroup programatically
|
|
8668
|
+
</span>
|
|
8669
|
+
</a>
|
|
8670
|
+
|
|
8671
|
+
<nav class="md-nav" aria-label="Creating new VLANs in a VLANGroup programatically">
|
|
8672
|
+
<ul class="md-nav__list">
|
|
8673
|
+
|
|
8674
|
+
<li class="md-nav__item">
|
|
8675
|
+
<a href="#creating-vlangroup-example" class="md-nav__link">
|
|
8676
|
+
<span class="md-ellipsis">
|
|
8677
|
+
Creating VLANGroup example
|
|
8678
|
+
</span>
|
|
8679
|
+
</a>
|
|
8680
|
+
|
|
8681
|
+
</li>
|
|
8682
|
+
|
|
8683
|
+
<li class="md-nav__item">
|
|
8684
|
+
<a href="#listing-available-vlans-example" class="md-nav__link">
|
|
8685
|
+
<span class="md-ellipsis">
|
|
8686
|
+
Listing available VLANs example
|
|
8687
|
+
</span>
|
|
8688
|
+
</a>
|
|
8689
|
+
|
|
8690
|
+
</li>
|
|
8691
|
+
|
|
8692
|
+
<li class="md-nav__item">
|
|
8693
|
+
<a href="#creating-new-vlans-example" class="md-nav__link">
|
|
8694
|
+
<span class="md-ellipsis">
|
|
8695
|
+
Creating new VLANs example
|
|
8696
|
+
</span>
|
|
8697
|
+
</a>
|
|
8698
|
+
|
|
8699
|
+
</li>
|
|
8700
|
+
|
|
8701
|
+
</ul>
|
|
8702
|
+
</nav>
|
|
8703
|
+
|
|
8704
|
+
</li>
|
|
8705
|
+
|
|
8706
|
+
</ul>
|
|
8707
|
+
|
|
8568
8708
|
</nav>
|
|
8569
8709
|
</div>
|
|
8570
8710
|
</div>
|
|
@@ -8584,6 +8724,171 @@
|
|
|
8584
8724
|
<h1 id="vlan-groups">VLAN Groups<a class="headerlink" href="#vlan-groups" title="Permanent link">¶</a></h1>
|
|
8585
8725
|
<p>VLAN groups can be used to organize VLANs within Nautobot. Each group may optionally be assigned to a specific location, but a group cannot belong to multiple locations.</p>
|
|
8586
8726
|
<p>Groups can also be used to enforce uniqueness: Each VLAN within a group must have a unique ID and name. VLANs which are not assigned to a group may have overlapping names and IDs (including VLANs which belong to a common location). For example, you can create two VLANs with ID 123, but they cannot both be assigned to the same group.</p>
|
|
8727
|
+
<h2 id="vlan-group-ranges">VLAN Group Ranges<a class="headerlink" href="#vlan-group-ranges" title="Permanent link">¶</a></h2>
|
|
8728
|
+
<details class="version-added">
|
|
8729
|
+
<summary>Added in version 2.3.6</summary>
|
|
8730
|
+
</details>
|
|
8731
|
+
<p>VLAN Groups contain a mandatory <code>range</code> field with a default value of <code>1-4094</code> (permitting all VLANs). This field may be used to constrain the valid member VLANs of the group. VLANs can only be associated with a given VLAN Group if their VLAN identifiers ("VIDs") fall within the specified <code>range</code>.
|
|
8732
|
+
Range value accepts commas and dashes, with examples as follows:</p>
|
|
8733
|
+
<ul>
|
|
8734
|
+
<li>1</li>
|
|
8735
|
+
<li>1-5</li>
|
|
8736
|
+
<li>1-5,10</li>
|
|
8737
|
+
<li>1-5,10-15</li>
|
|
8738
|
+
<li>1-5,10-15,16,17,18,19,20</li>
|
|
8739
|
+
</ul>
|
|
8740
|
+
<p>Values between dashes will also be expanded into a list of VLANs.</p>
|
|
8741
|
+
<h2 id="creating-new-vlans-in-a-vlangroup-programatically">Creating new VLANs in a VLANGroup programatically<a class="headerlink" href="#creating-new-vlans-in-a-vlangroup-programatically" title="Permanent link">¶</a></h2>
|
|
8742
|
+
<details class="version-added">
|
|
8743
|
+
<summary>Added in version 2.3.6</summary>
|
|
8744
|
+
</details>
|
|
8745
|
+
<p>VLAN Groups offer an API endpoint to list available VIDs and create new VLANs programmatically:</p>
|
|
8746
|
+
<p><code>/api/ipam/vlan-groups/<vlan_group_id>/available-vlans/</code></p>
|
|
8747
|
+
<p>A <code>GET</code> request to this API endpoint will return a list of all available (unassigned) VIDs available in the given <code>VLANGroup</code>.</p>
|
|
8748
|
+
<p>A <code>POST</code> request to the same API endpoint will create <code>VLAN</code> record(s) in the given <code>VLANGroup</code>. Note that you must specify the <code>name</code> and <code>status</code> of each VLAN to be created as a part of this request, but the <code>vlan_group</code> and <code>vid</code> may be omitted as they can be automatically assigned by this API. See below.</p>
|
|
8749
|
+
<h3 id="creating-vlangroup-example">Creating VLANGroup example<a class="headerlink" href="#creating-vlangroup-example" title="Permanent link">¶</a></h3>
|
|
8750
|
+
<p>To create a new <code>VLANGroup</code> with a <code>range</code> field of: <code>5-10</code> (permit VLANs <code>5, 6, 7, 8, 9, 10</code>), issue following POST request:</p>
|
|
8751
|
+
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>curl -X POST -H "Authorization: Token $TOKEN" \
|
|
8752
|
+
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>-H "Content-Type: application/json" \
|
|
8753
|
+
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>-H "Accept: application/json; version=2.0; indent=4" \
|
|
8754
|
+
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a>http://nautobot/api/ipam/vlan-groups/ \
|
|
8755
|
+
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>--data '[{"name": "Enterprise VLANs", "range": "5-10"}]'
|
|
8756
|
+
</code></pre></div>
|
|
8757
|
+
<p><code>VLANGroup</code> was created as follows:</p>
|
|
8758
|
+
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="p">[</span>
|
|
8759
|
+
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="w"> </span><span class="p">{</span>
|
|
8760
|
+
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"c16d5d1d-40d6-4902-b89d-6294e60cb4bf"</span><span class="p">,</span>
|
|
8761
|
+
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="w"> </span><span class="nt">"object_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ipam.vlangroup"</span><span class="p">,</span>
|
|
8762
|
+
<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a><span class="w"> </span><span class="nt">"display"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enterprise VLANs"</span><span class="p">,</span>
|
|
8763
|
+
<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a><span class="w"> </span><span class="nt">"url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://nautobot/api/ipam/vlan-groups/c16d5d1d-40d6-4902-b89d-6294e60cb4bf/"</span><span class="p">,</span>
|
|
8764
|
+
<a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a><span class="w"> </span><span class="nt">"natural_slug"</span><span class="p">:</span><span class="w"> </span><span class="s2">"enterprise-vlans_c16d"</span><span class="p">,</span>
|
|
8765
|
+
<a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a><span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enterprise VLANs"</span><span class="p">,</span>
|
|
8766
|
+
<a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a><span class="w"> </span><span class="nt">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span>
|
|
8767
|
+
<a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a><span class="w"> </span><span class="nt">"range"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5-10"</span><span class="p">,</span>
|
|
8768
|
+
<a id="__codelineno-1-11" name="__codelineno-1-11" href="#__codelineno-1-11"></a><span class="w"> </span><span class="nt">"location"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span>
|
|
8769
|
+
<a id="__codelineno-1-12" name="__codelineno-1-12" href="#__codelineno-1-12"></a><span class="w"> </span><span class="nt">"created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2024-09-25T09:27:16.343655Z"</span><span class="p">,</span>
|
|
8770
|
+
<a id="__codelineno-1-13" name="__codelineno-1-13" href="#__codelineno-1-13"></a><span class="w"> </span><span class="nt">"last_updated"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2024-09-25T09:27:16.343670Z"</span><span class="p">,</span>
|
|
8771
|
+
<a id="__codelineno-1-14" name="__codelineno-1-14" href="#__codelineno-1-14"></a><span class="w"> </span><span class="nt">"notes_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://nautobot/api/ipam/vlan-groups/c16d5d1d-40d6-4902-b89d-6294e60cb4bf/notes/"</span><span class="p">,</span>
|
|
8772
|
+
<a id="__codelineno-1-15" name="__codelineno-1-15" href="#__codelineno-1-15"></a><span class="w"> </span><span class="nt">"custom_fields"</span><span class="p">:</span><span class="w"> </span><span class="p">{},</span>
|
|
8773
|
+
<a id="__codelineno-1-16" name="__codelineno-1-16" href="#__codelineno-1-16"></a><span class="w"> </span><span class="nt">"computed_fields"</span><span class="p">:</span><span class="w"> </span><span class="p">{},</span>
|
|
8774
|
+
<a id="__codelineno-1-17" name="__codelineno-1-17" href="#__codelineno-1-17"></a><span class="w"> </span><span class="nt">"relationships"</span><span class="p">:</span><span class="w"> </span><span class="p">{}</span>
|
|
8775
|
+
<a id="__codelineno-1-18" name="__codelineno-1-18" href="#__codelineno-1-18"></a><span class="w"> </span><span class="p">}</span>
|
|
8776
|
+
<a id="__codelineno-1-19" name="__codelineno-1-19" href="#__codelineno-1-19"></a><span class="p">]</span>
|
|
8777
|
+
</code></pre></div>
|
|
8778
|
+
<h3 id="listing-available-vlans-example">Listing available VLANs example<a class="headerlink" href="#listing-available-vlans-example" title="Permanent link">¶</a></h3>
|
|
8779
|
+
<p>Then, to list all available VLAN IDs within the just-created <code>VLANGroup</code>, issue a GET request:</p>
|
|
8780
|
+
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>curl -X GET -H "Authorization: Token $TOKEN" \
|
|
8781
|
+
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a>-H "Content-Type: application/json" \
|
|
8782
|
+
<a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a>-H "Accept: application/json; version=2.0; indent=4" \
|
|
8783
|
+
<a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a>http://nautobot/api/ipam/vlan-groups/c16d5d1d-40d6-4902-b89d-6294e60cb4bf/available-vlans/
|
|
8784
|
+
</code></pre></div>
|
|
8785
|
+
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="p">{</span>
|
|
8786
|
+
<a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a><span class="w"> </span><span class="nt">"count"</span><span class="p">:</span><span class="w"> </span><span class="mi">6</span><span class="p">,</span>
|
|
8787
|
+
<a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a><span class="w"> </span><span class="nt">"next"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span>
|
|
8788
|
+
<a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a><span class="w"> </span><span class="nt">"previous"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span>
|
|
8789
|
+
<a id="__codelineno-3-5" name="__codelineno-3-5" href="#__codelineno-3-5"></a><span class="w"> </span><span class="nt">"results"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
|
|
8790
|
+
<a id="__codelineno-3-6" name="__codelineno-3-6" href="#__codelineno-3-6"></a><span class="w"> </span><span class="mi">5</span><span class="p">,</span>
|
|
8791
|
+
<a id="__codelineno-3-7" name="__codelineno-3-7" href="#__codelineno-3-7"></a><span class="w"> </span><span class="mi">6</span><span class="p">,</span>
|
|
8792
|
+
<a id="__codelineno-3-8" name="__codelineno-3-8" href="#__codelineno-3-8"></a><span class="w"> </span><span class="mi">7</span><span class="p">,</span>
|
|
8793
|
+
<a id="__codelineno-3-9" name="__codelineno-3-9" href="#__codelineno-3-9"></a><span class="w"> </span><span class="mi">8</span><span class="p">,</span>
|
|
8794
|
+
<a id="__codelineno-3-10" name="__codelineno-3-10" href="#__codelineno-3-10"></a><span class="w"> </span><span class="mi">9</span><span class="p">,</span>
|
|
8795
|
+
<a id="__codelineno-3-11" name="__codelineno-3-11" href="#__codelineno-3-11"></a><span class="w"> </span><span class="mi">10</span>
|
|
8796
|
+
<a id="__codelineno-3-12" name="__codelineno-3-12" href="#__codelineno-3-12"></a><span class="w"> </span><span class="p">]</span>
|
|
8797
|
+
<a id="__codelineno-3-13" name="__codelineno-3-13" href="#__codelineno-3-13"></a><span class="p">}</span>
|
|
8798
|
+
</code></pre></div>
|
|
8799
|
+
<h3 id="creating-new-vlans-example">Creating new VLANs example<a class="headerlink" href="#creating-new-vlans-example" title="Permanent link">¶</a></h3>
|
|
8800
|
+
<p>The <code>/api/ipam/vlan-groups/<vlan_group_id>/available-vlans/</code> API endpoint accepts <code>POST</code> requests to create a new VLAN record, similar to the <code>/api/ipam/vlans/</code> API endpoint. However, there are some characteristic differences in the behavior of <code>/available-vlans/</code> with regard to its input and output:</p>
|
|
8801
|
+
<ul>
|
|
8802
|
+
<li>Accepts a single dictionary as input to create 1 VLAN, in which case it returns a single dictionary describing the created VLAN</li>
|
|
8803
|
+
<li>Accepts a list of dictionaries as input to create one or more VLANs, in which case it returns a list of VLAN objects</li>
|
|
8804
|
+
<li>The fields <code>name</code> and <code>status</code> of are mandatory inputs for each VLAN to be created</li>
|
|
8805
|
+
<li>The field <code>vid</code> is optional and might be specified to override auto-allocation for a given VLAN<ul>
|
|
8806
|
+
<li>Will not accept a request with the same <code>vid</code> value specified multiple times</li>
|
|
8807
|
+
</ul>
|
|
8808
|
+
</li>
|
|
8809
|
+
<li>Will not accept a <code>vlan_group</code> attribute different than that already specified in the request's URL</li>
|
|
8810
|
+
<li>Other <code>VLAN</code> model fields are permitted and optional</li>
|
|
8811
|
+
<li>As with the <code>/vlans/</code> endpoint, specifying <code>locations</code> in the POST request is not presently supported; you can make a subsequent call(s) to the <code>/api/ipam/vlan-location-assignments/</code> endpoint to update the many-to-many association between the created VLAN(s) and desired Location(s)</li>
|
|
8812
|
+
</ul>
|
|
8813
|
+
<p>To create two new VLANs, a data payload has to be specified. In the case of the first VLAN, its <code>VLAN ID</code> will be automatically determined based on <code>VLANGroups</code> availability, in the case of the second VLAN we explicitly request <code>vid</code> 8:</p>
|
|
8814
|
+
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>curl -X POST -H "Authorization: Token $TOKEN" \
|
|
8815
|
+
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>-H "Content-Type: application/json" \
|
|
8816
|
+
<a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a>-H "Accept: application/json; version=2.0; indent=4" \
|
|
8817
|
+
<a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a>http://nautobot/api/ipam/vlan-groups/c16d5d1d-40d6-4902-b89d-6294e60cb4bf/available-vlans/ \
|
|
8818
|
+
<a id="__codelineno-4-5" name="__codelineno-4-5" href="#__codelineno-4-5"></a>--data '[
|
|
8819
|
+
<a id="__codelineno-4-6" name="__codelineno-4-6" href="#__codelineno-4-6"></a>{"name": "First VLAN", "status": "1e560c4d-07ef-4d49-af6e-c85aa1f295d3"},
|
|
8820
|
+
<a id="__codelineno-4-7" name="__codelineno-4-7" href="#__codelineno-4-7"></a>{"name": "Second VLAN", "vid": 8, "status": "1e560c4d-07ef-4d49-af6e-c85aa1f295d3"}
|
|
8821
|
+
<a id="__codelineno-4-8" name="__codelineno-4-8" href="#__codelineno-4-8"></a>]'
|
|
8822
|
+
</code></pre></div>
|
|
8823
|
+
<p><code>VLANs</code> created:</p>
|
|
8824
|
+
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="p">{</span>
|
|
8825
|
+
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a><span class="w"> </span><span class="nt">"count"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span>
|
|
8826
|
+
<a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a><span class="w"> </span><span class="nt">"next"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span>
|
|
8827
|
+
<a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a><span class="w"> </span><span class="nt">"previous"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span>
|
|
8828
|
+
<a id="__codelineno-5-5" name="__codelineno-5-5" href="#__codelineno-5-5"></a><span class="w"> </span><span class="nt">"results"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
|
|
8829
|
+
<a id="__codelineno-5-6" name="__codelineno-5-6" href="#__codelineno-5-6"></a><span class="w"> </span><span class="p">{</span>
|
|
8830
|
+
<a id="__codelineno-5-7" name="__codelineno-5-7" href="#__codelineno-5-7"></a><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"58bd2a10-33f7-45e2-93d2-f56be25dfe8c"</span><span class="p">,</span>
|
|
8831
|
+
<a id="__codelineno-5-8" name="__codelineno-5-8" href="#__codelineno-5-8"></a><span class="w"> </span><span class="nt">"object_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ipam.vlan"</span><span class="p">,</span>
|
|
8832
|
+
<a id="__codelineno-5-9" name="__codelineno-5-9" href="#__codelineno-5-9"></a><span class="w"> </span><span class="nt">"display"</span><span class="p">:</span><span class="w"> </span><span class="s2">"First VLAN (5)"</span><span class="p">,</span>
|
|
8833
|
+
<a id="__codelineno-5-10" name="__codelineno-5-10" href="#__codelineno-5-10"></a><span class="w"> </span><span class="nt">"url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://nautobot/api/ipam/vlans/58bd2a10-33f7-45e2-93d2-f56be25dfe8c/"</span><span class="p">,</span>
|
|
8834
|
+
<a id="__codelineno-5-11" name="__codelineno-5-11" href="#__codelineno-5-11"></a><span class="w"> </span><span class="nt">"natural_slug"</span><span class="p">:</span><span class="w"> </span><span class="s2">"58bd2a10-33f7-45e2-93d2-f56be25dfe8c_58bd"</span><span class="p">,</span>
|
|
8835
|
+
<a id="__codelineno-5-12" name="__codelineno-5-12" href="#__codelineno-5-12"></a><span class="w"> </span><span class="nt">"vid"</span><span class="p">:</span><span class="w"> </span><span class="mi">5</span><span class="p">,</span>
|
|
8836
|
+
<a id="__codelineno-5-13" name="__codelineno-5-13" href="#__codelineno-5-13"></a><span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"First VLAN"</span><span class="p">,</span>
|
|
8837
|
+
<a id="__codelineno-5-14" name="__codelineno-5-14" href="#__codelineno-5-14"></a><span class="w"> </span><span class="nt">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span>
|
|
8838
|
+
<a id="__codelineno-5-15" name="__codelineno-5-15" href="#__codelineno-5-15"></a><span class="w"> </span><span class="nt">"vlan_group"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
|
8839
|
+
<a id="__codelineno-5-16" name="__codelineno-5-16" href="#__codelineno-5-16"></a><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"c16d5d1d-40d6-4902-b89d-6294e60cb4bf"</span><span class="p">,</span>
|
|
8840
|
+
<a id="__codelineno-5-17" name="__codelineno-5-17" href="#__codelineno-5-17"></a><span class="w"> </span><span class="nt">"object_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ipam.vlangroup"</span><span class="p">,</span>
|
|
8841
|
+
<a id="__codelineno-5-18" name="__codelineno-5-18" href="#__codelineno-5-18"></a><span class="w"> </span><span class="nt">"url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://nautobot/api/ipam/vlan-groups/c16d5d1d-40d6-4902-b89d-6294e60cb4bf/"</span>
|
|
8842
|
+
<a id="__codelineno-5-19" name="__codelineno-5-19" href="#__codelineno-5-19"></a><span class="w"> </span><span class="p">},</span>
|
|
8843
|
+
<a id="__codelineno-5-20" name="__codelineno-5-20" href="#__codelineno-5-20"></a><span class="w"> </span><span class="nt">"status"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
|
8844
|
+
<a id="__codelineno-5-21" name="__codelineno-5-21" href="#__codelineno-5-21"></a><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1e560c4d-07ef-4d49-af6e-c85aa1f295d3"</span><span class="p">,</span>
|
|
8845
|
+
<a id="__codelineno-5-22" name="__codelineno-5-22" href="#__codelineno-5-22"></a><span class="w"> </span><span class="nt">"object_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"extras.status"</span><span class="p">,</span>
|
|
8846
|
+
<a id="__codelineno-5-23" name="__codelineno-5-23" href="#__codelineno-5-23"></a><span class="w"> </span><span class="nt">"url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://nautobot/api/extras/statuses/1e560c4d-07ef-4d49-af6e-c85aa1f295d3/"</span>
|
|
8847
|
+
<a id="__codelineno-5-24" name="__codelineno-5-24" href="#__codelineno-5-24"></a><span class="w"> </span><span class="p">},</span>
|
|
8848
|
+
<a id="__codelineno-5-25" name="__codelineno-5-25" href="#__codelineno-5-25"></a><span class="w"> </span><span class="nt">"role"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span>
|
|
8849
|
+
<a id="__codelineno-5-26" name="__codelineno-5-26" href="#__codelineno-5-26"></a><span class="w"> </span><span class="nt">"tenant"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span>
|
|
8850
|
+
<a id="__codelineno-5-27" name="__codelineno-5-27" href="#__codelineno-5-27"></a><span class="w"> </span><span class="nt">"locations"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span>
|
|
8851
|
+
<a id="__codelineno-5-28" name="__codelineno-5-28" href="#__codelineno-5-28"></a><span class="w"> </span><span class="nt">"created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2024-09-25T09:36:07.587950Z"</span><span class="p">,</span>
|
|
8852
|
+
<a id="__codelineno-5-29" name="__codelineno-5-29" href="#__codelineno-5-29"></a><span class="w"> </span><span class="nt">"last_updated"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2024-09-25T09:36:07.587963Z"</span><span class="p">,</span>
|
|
8853
|
+
<a id="__codelineno-5-30" name="__codelineno-5-30" href="#__codelineno-5-30"></a><span class="w"> </span><span class="nt">"tags"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span>
|
|
8854
|
+
<a id="__codelineno-5-31" name="__codelineno-5-31" href="#__codelineno-5-31"></a><span class="w"> </span><span class="nt">"notes_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://nautobot/api/ipam/vlans/58bd2a10-33f7-45e2-93d2-f56be25dfe8c/notes/"</span><span class="p">,</span>
|
|
8855
|
+
<a id="__codelineno-5-32" name="__codelineno-5-32" href="#__codelineno-5-32"></a><span class="w"> </span><span class="nt">"custom_fields"</span><span class="p">:</span><span class="w"> </span><span class="p">{},</span>
|
|
8856
|
+
<a id="__codelineno-5-33" name="__codelineno-5-33" href="#__codelineno-5-33"></a><span class="w"> </span><span class="nt">"computed_fields"</span><span class="p">:</span><span class="w"> </span><span class="p">{},</span>
|
|
8857
|
+
<a id="__codelineno-5-34" name="__codelineno-5-34" href="#__codelineno-5-34"></a><span class="w"> </span><span class="nt">"relationships"</span><span class="p">:</span><span class="w"> </span><span class="p">{}</span>
|
|
8858
|
+
<a id="__codelineno-5-35" name="__codelineno-5-35" href="#__codelineno-5-35"></a><span class="w"> </span><span class="p">},</span>
|
|
8859
|
+
<a id="__codelineno-5-36" name="__codelineno-5-36" href="#__codelineno-5-36"></a><span class="w"> </span><span class="p">{</span>
|
|
8860
|
+
<a id="__codelineno-5-37" name="__codelineno-5-37" href="#__codelineno-5-37"></a><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"9b7c6b03-9140-4b00-940f-5dbcde173de1"</span><span class="p">,</span>
|
|
8861
|
+
<a id="__codelineno-5-38" name="__codelineno-5-38" href="#__codelineno-5-38"></a><span class="w"> </span><span class="nt">"object_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ipam.vlan"</span><span class="p">,</span>
|
|
8862
|
+
<a id="__codelineno-5-39" name="__codelineno-5-39" href="#__codelineno-5-39"></a><span class="w"> </span><span class="nt">"display"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Second VLAN (8)"</span><span class="p">,</span>
|
|
8863
|
+
<a id="__codelineno-5-40" name="__codelineno-5-40" href="#__codelineno-5-40"></a><span class="w"> </span><span class="nt">"url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://nautobot/api/ipam/vlans/9b7c6b03-9140-4b00-940f-5dbcde173de1/"</span><span class="p">,</span>
|
|
8864
|
+
<a id="__codelineno-5-41" name="__codelineno-5-41" href="#__codelineno-5-41"></a><span class="w"> </span><span class="nt">"natural_slug"</span><span class="p">:</span><span class="w"> </span><span class="s2">"9b7c6b03-9140-4b00-940f-5dbcde173de1_9b7c"</span><span class="p">,</span>
|
|
8865
|
+
<a id="__codelineno-5-42" name="__codelineno-5-42" href="#__codelineno-5-42"></a><span class="w"> </span><span class="nt">"vid"</span><span class="p">:</span><span class="w"> </span><span class="mi">8</span><span class="p">,</span>
|
|
8866
|
+
<a id="__codelineno-5-43" name="__codelineno-5-43" href="#__codelineno-5-43"></a><span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Second VLAN"</span><span class="p">,</span>
|
|
8867
|
+
<a id="__codelineno-5-44" name="__codelineno-5-44" href="#__codelineno-5-44"></a><span class="w"> </span><span class="nt">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span>
|
|
8868
|
+
<a id="__codelineno-5-45" name="__codelineno-5-45" href="#__codelineno-5-45"></a><span class="w"> </span><span class="nt">"vlan_group"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
|
8869
|
+
<a id="__codelineno-5-46" name="__codelineno-5-46" href="#__codelineno-5-46"></a><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"c16d5d1d-40d6-4902-b89d-6294e60cb4bf"</span><span class="p">,</span>
|
|
8870
|
+
<a id="__codelineno-5-47" name="__codelineno-5-47" href="#__codelineno-5-47"></a><span class="w"> </span><span class="nt">"object_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ipam.vlangroup"</span><span class="p">,</span>
|
|
8871
|
+
<a id="__codelineno-5-48" name="__codelineno-5-48" href="#__codelineno-5-48"></a><span class="w"> </span><span class="nt">"url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://nautobot/api/ipam/vlan-groups/c16d5d1d-40d6-4902-b89d-6294e60cb4bf/"</span>
|
|
8872
|
+
<a id="__codelineno-5-49" name="__codelineno-5-49" href="#__codelineno-5-49"></a><span class="w"> </span><span class="p">},</span>
|
|
8873
|
+
<a id="__codelineno-5-50" name="__codelineno-5-50" href="#__codelineno-5-50"></a><span class="w"> </span><span class="nt">"status"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
|
8874
|
+
<a id="__codelineno-5-51" name="__codelineno-5-51" href="#__codelineno-5-51"></a><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1e560c4d-07ef-4d49-af6e-c85aa1f295d3"</span><span class="p">,</span>
|
|
8875
|
+
<a id="__codelineno-5-52" name="__codelineno-5-52" href="#__codelineno-5-52"></a><span class="w"> </span><span class="nt">"object_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"extras.status"</span><span class="p">,</span>
|
|
8876
|
+
<a id="__codelineno-5-53" name="__codelineno-5-53" href="#__codelineno-5-53"></a><span class="w"> </span><span class="nt">"url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://nautobot/api/extras/statuses/1e560c4d-07ef-4d49-af6e-c85aa1f295d3/"</span>
|
|
8877
|
+
<a id="__codelineno-5-54" name="__codelineno-5-54" href="#__codelineno-5-54"></a><span class="w"> </span><span class="p">},</span>
|
|
8878
|
+
<a id="__codelineno-5-55" name="__codelineno-5-55" href="#__codelineno-5-55"></a><span class="w"> </span><span class="nt">"role"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span>
|
|
8879
|
+
<a id="__codelineno-5-56" name="__codelineno-5-56" href="#__codelineno-5-56"></a><span class="w"> </span><span class="nt">"tenant"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span>
|
|
8880
|
+
<a id="__codelineno-5-57" name="__codelineno-5-57" href="#__codelineno-5-57"></a><span class="w"> </span><span class="nt">"locations"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span>
|
|
8881
|
+
<a id="__codelineno-5-58" name="__codelineno-5-58" href="#__codelineno-5-58"></a><span class="w"> </span><span class="nt">"created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2024-09-25T09:36:07.634563Z"</span><span class="p">,</span>
|
|
8882
|
+
<a id="__codelineno-5-59" name="__codelineno-5-59" href="#__codelineno-5-59"></a><span class="w"> </span><span class="nt">"last_updated"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2024-09-25T09:36:07.634578Z"</span><span class="p">,</span>
|
|
8883
|
+
<a id="__codelineno-5-60" name="__codelineno-5-60" href="#__codelineno-5-60"></a><span class="w"> </span><span class="nt">"tags"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span>
|
|
8884
|
+
<a id="__codelineno-5-61" name="__codelineno-5-61" href="#__codelineno-5-61"></a><span class="w"> </span><span class="nt">"notes_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://nautobot/api/ipam/vlans/9b7c6b03-9140-4b00-940f-5dbcde173de1/notes/"</span><span class="p">,</span>
|
|
8885
|
+
<a id="__codelineno-5-62" name="__codelineno-5-62" href="#__codelineno-5-62"></a><span class="w"> </span><span class="nt">"custom_fields"</span><span class="p">:</span><span class="w"> </span><span class="p">{},</span>
|
|
8886
|
+
<a id="__codelineno-5-63" name="__codelineno-5-63" href="#__codelineno-5-63"></a><span class="w"> </span><span class="nt">"computed_fields"</span><span class="p">:</span><span class="w"> </span><span class="p">{},</span>
|
|
8887
|
+
<a id="__codelineno-5-64" name="__codelineno-5-64" href="#__codelineno-5-64"></a><span class="w"> </span><span class="nt">"relationships"</span><span class="p">:</span><span class="w"> </span><span class="p">{}</span>
|
|
8888
|
+
<a id="__codelineno-5-65" name="__codelineno-5-65" href="#__codelineno-5-65"></a><span class="w"> </span><span class="p">}</span>
|
|
8889
|
+
<a id="__codelineno-5-66" name="__codelineno-5-66" href="#__codelineno-5-66"></a><span class="w"> </span><span class="p">]</span>
|
|
8890
|
+
<a id="__codelineno-5-67" name="__codelineno-5-67" href="#__codelineno-5-67"></a><span class="p">}</span>
|
|
8891
|
+
</code></pre></div>
|
|
8587
8892
|
|
|
8588
8893
|
|
|
8589
8894
|
|