Skip to content

Commit 8381c5a

Browse files
rodvandrodvand
authored
Release 3.4.0 (#643)
* Increase galaxy version and generate docs * Generate changelog
1 parent 213f8a2 commit 8381c5a

File tree

68 files changed

+1186
-517
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+1186
-517
lines changed

‎CHANGELOG.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,34 @@ NetBox.NetBox Release Notes
55
.. contents:: Topics
66

77

8+
v3.4.0
9+
======
10+
11+
Minor Changes
12+
-------------
13+
14+
- nb_inventory - Add documentation for use of inventory plugin in Tower/AWX [#648](https://github.com/netbox-community/ansible_modules/pull/648)
15+
- nb_inventory - Cache OpenAPI locally to speed up inventory [#617](https://github.com/netbox-community/ansible_modules/pull/617)
16+
- nb_lookup - Add missing endpoints to nb_lookup [#655](https://github.com/netbox-community/ansible_modules/pull/655)
17+
- netbox_cable - Improve lookup speed on NetBox versions earlier than 3.0.6 [#645](https://github.com/netbox-community/ansible_modules/pull/645)
18+
- netbox_inventory_item - Add label and custom fields to module [#632](https://github.com/netbox-community/ansible_modules/pull/632)
19+
- netbox_provider_network - Add module for handling provider networks [#653](https://github.com/netbox-community/ansible_modules/pull/653)
20+
- netbox_virtual_chassis - Add custom_fields to netbox_virtual_chassis [#657](https://github.com/netbox-community/ansible_modules/pull/657)
21+
- netbox_vm_interface - Add custom fields to module [#637](https://github.com/netbox-community/ansible_modules/pull/637)
22+
23+
Bugfixes
24+
--------
25+
26+
- nb_lookup - Fix documentation of validate_cert [#629](https://github.com/netbox-community/ansible_modules/pull/629)
27+
- netbox_site - Ensure idempotency between NetBox version 2.11 and 3.00 [#631](https://github.com/netbox-community/ansible_modules/pull/631)
28+
- netbox_virtual_chassis - Fix issue with virtual chassis creation [#657](https://github.com/netbox-community/ansible_modules/pull/657)
29+
- netbox_virtual_machine - Ensure idempotency between NetBox version 2.11 and 3.00 [#633](https://github.com/netbox-community/ansible_modules/pull/633)
30+
31+
New Modules
32+
-----------
33+
34+
- netbox.netbox.netbox_provider_network - Create, update or delete Provider Network in NetBox
35+
836
v3.3.0
937
======
1038

‎changelogs/changelog.yaml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -583,3 +583,24 @@ releases:
583583
name: netbox_config_context
584584
namespace: ''
585585
release_date: '2021-10-25'
586+
3.4.0:
587+
changes:
588+
minor_changes:
589+
- netbox_inventory_item - Add label and custom fields to module [#632](https://github.com/netbox-community/ansible_modules/pull/632)
590+
- nb_inventory - Cache OpenAPI locally to speed up inventory [#617](https://github.com/netbox-community/ansible_modules/pull/617)
591+
- netbox_vm_interface - Add custom fields to module [#637](https://github.com/netbox-community/ansible_modules/pull/637)
592+
- netbox_provider_network - Add module for handling provider networks [#653](https://github.com/netbox-community/ansible_modules/pull/653)
593+
- nb_lookup - Add missing endpoints to nb_lookup [#655](https://github.com/netbox-community/ansible_modules/pull/655)
594+
- netbox_virtual_chassis - Add custom_fields to netbox_virtual_chassis [#657](https://github.com/netbox-community/ansible_modules/pull/657)
595+
- nb_inventory - Add documentation for use of inventory plugin in Tower/AWX [#648](https://github.com/netbox-community/ansible_modules/pull/648)
596+
- netbox_cable - Improve lookup speed on NetBox versions earlier than 3.0.6 [#645](https://github.com/netbox-community/ansible_modules/pull/645)
597+
bugfixes:
598+
- netbox_site - Ensure idempotency between NetBox version 2.11 and 3.00 [#631](https://github.com/netbox-community/ansible_modules/pull/631)
599+
- netbox_virtual_machine - Ensure idempotency between NetBox version 2.11 and 3.00 [#633](https://github.com/netbox-community/ansible_modules/pull/633)
600+
- nb_lookup - Fix documentation of validate_cert [#629](https://github.com/netbox-community/ansible_modules/pull/629)
601+
- netbox_virtual_chassis - Fix issue with virtual chassis creation [#657](https://github.com/netbox-community/ansible_modules/pull/657)
602+
modules:
603+
- description: Create, update or delete Provider Network in NetBox
604+
name: netbox_provider_network
605+
namespace: ''
606+
release_date: '2021-11-28'

‎docs/plugins/index.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
.. _plugins_in_netbox.netbox:
44

5-
NetBox.NetBox
5+
Netbox.Netbox
66
=============
77

8-
Collection version 3.3.0
8+
Collection version 3.4.0
99

1010
.. toctree::
1111
:maxdepth: 1
@@ -65,6 +65,7 @@ Modules
6565
* :ref:`netbox_power_port_template <ansible_collections.netbox.netbox.netbox_power_port_template_module>` -- Create, update or delete power port templates within NetBox
6666
* :ref:`netbox_prefix <ansible_collections.netbox.netbox.netbox_prefix_module>` -- Creates or removes prefixes from NetBox
6767
* :ref:`netbox_provider <ansible_collections.netbox.netbox.netbox_provider_module>` -- Create, update or delete providers within NetBox
68+
* :ref:`netbox_provider_network <ansible_collections.netbox.netbox.netbox_provider_network_module>` -- Create, update or delete provider networks within NetBox
6869
* :ref:`netbox_rack <ansible_collections.netbox.netbox.netbox_rack_module>` -- Create, update or delete racks within NetBox
6970
* :ref:`netbox_rack_group <ansible_collections.netbox.netbox.netbox_rack_group_module>` -- Create, update or delete racks groups within NetBox
7071
* :ref:`netbox_rack_role <ansible_collections.netbox.netbox.netbox_rack_role_module>` -- Create, update or delete racks roles within NetBox

‎docs/plugins/nb_inventory_inventory.rst

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ netbox.netbox.nb_inventory -- NetBox inventory source
2020
.. Collection note
2121
2222
.. note::
23-
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.3.0).
23+
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.4.0).
2424

2525
To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
2626

@@ -1016,6 +1016,28 @@ Examples
10161016
- prefix: status
10171017
key: status.value
10181018

1019+
# For use in Ansible Tower (AWX), please see this blog from RedHat: https://www.ansible.com/blog/using-an-inventory-plugin-from-a-collection-in-ansible-tower
1020+
# The credential for NetBox will need to expose NETBOX_API and NETBOX_TOKEN as environment variables.
1021+
# Example Ansible Tower credential Input Configuration:
1022+
1023+
fields:
1024+
- id: NETBOX_API
1025+
type: string
1026+
label: NetBox Host URL
1027+
- id: NETBOX_TOKEN
1028+
type: string
1029+
label: NetBox API Token
1030+
secret: true
1031+
required:
1032+
- NETBOX_API
1033+
- NETBOX_TOKEN
1034+
1035+
# Example Ansible Tower credential Injector Configuration:
1036+
1037+
env:
1038+
NETBOX_API: '{{ NETBOX_API }}'
1039+
NETBOX_TOKEN: '{{ NETBOX_TOKEN }}'
1040+
10191041

10201042

10211043

‎docs/plugins/nb_lookup_lookup.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ netbox.netbox.nb_lookup -- Queries and returns elements from NetBox
2020
.. Collection note
2121
2222
.. note::
23-
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.3.0).
23+
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.4.0).
2424

2525
To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
2626

@@ -235,7 +235,7 @@ Parameters
235235
</div>
236236
</td>
237237
<td>
238-
<b>Default:</b><br/><div style="color: blue">True</div>
238+
<b>Default:</b><br/><div style="color: blue">"yes"</div>
239239
</td>
240240
<td>
241241
</td>

‎docs/plugins/netbox_aggregate_module.rst

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ netbox.netbox.netbox_aggregate -- Creates or removes aggregates from NetBox
2020
.. Collection note
2121
2222
.. note::
23-
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.3.0).
23+
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.4.0).
2424

2525
To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
2626

@@ -209,7 +209,7 @@ Parameters
209209
<td>
210210
</td>
211211
<td>
212-
<div>The token created within NetBox to authorize API access</div>
212+
<div>The NetBox API token.</div>
213213
</td>
214214
</tr>
215215
<tr>
@@ -224,7 +224,8 @@ Parameters
224224
<td>
225225
</td>
226226
<td>
227-
<div>URL of the NetBox instance resolvable by Ansible control host</div>
227+
<div>The URL of the NetBox instance.</div>
228+
<div>Must be accessible by the Ansible control host.</div>
228229
</td>
229230
</tr>
230231
<tr>
@@ -239,7 +240,7 @@ Parameters
239240
<td>
240241
</td>
241242
<td>
242-
<div>This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined</div>
243+
<div>This can be used to override the specified values in ALLOWED_QUERY_PARAMS that are defined</div>
243244
<div>in plugins/module_utils/netbox_utils.py and provides control to users on what may make</div>
244245
<div>an object unique in their environment.</div>
245246
</td>
@@ -260,7 +261,7 @@ Parameters
260261
</ul>
261262
</td>
262263
<td>
263-
<div>The state of the aggregate</div>
264+
<div>The state of the object.</div>
264265
</td>
265266
</tr>
266267
<tr>
@@ -276,7 +277,8 @@ Parameters
276277
<b>Default:</b><br/><div style="color: blue">"yes"</div>
277278
</td>
278279
<td>
279-
<div>If <code>no</code>, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.</div>
280+
<div>If <code>no</code>, SSL certificates will not be validated.</div>
281+
<div>This should only be used on personally controlled sites using a self-signed certificates.</div>
280282
</td>
281283
</tr>
282284
</table>

‎docs/plugins/netbox_cable_module.rst

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ netbox.netbox.netbox_cable -- Create, update or delete cables within NetBox
2020
.. Collection note
2121
2222
.. note::
23-
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.3.0).
23+
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.4.0).
2424

2525
To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
2626

@@ -344,7 +344,7 @@ Parameters
344344
<td>
345345
</td>
346346
<td>
347-
<div>The token created within NetBox to authorize API access</div>
347+
<div>The NetBox API token.</div>
348348
</td>
349349
</tr>
350350
<tr>
@@ -359,7 +359,8 @@ Parameters
359359
<td>
360360
</td>
361361
<td>
362-
<div>URL of the NetBox instance resolvable by Ansible control host</div>
362+
<div>The URL of the NetBox instance.</div>
363+
<div>Must be accessible by the Ansible control host.</div>
363364
</td>
364365
</tr>
365366
<tr>
@@ -374,7 +375,7 @@ Parameters
374375
<td>
375376
</td>
376377
<td>
377-
<div>This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined</div>
378+
<div>This can be used to override the specified values in ALLOWED_QUERY_PARAMS that are defined</div>
378379
<div>in plugins/module_utils/netbox_utils.py and provides control to users on what may make</div>
379380
<div>an object unique in their environment.</div>
380381
</td>
@@ -390,12 +391,12 @@ Parameters
390391
</td>
391392
<td>
392393
<ul style="margin: 0; padding: 0"><b>Choices:</b>
393-
<li>absent</li>
394-
<li><div style="color: blue"><b>present</b>&nbsp;&larr;</div></li>
394+
<li><div style="color: blue"><b>present</b>&nbsp;&larr;</div></li>
395+
<li>absent</li>
395396
</ul>
396397
</td>
397398
<td>
398-
<div>Use <code>present</code> or <code>absent</code> for adding or removing.</div>
399+
<div>The state of the object.</div>
399400
</td>
400401
</tr>
401402
<tr>
@@ -411,7 +412,8 @@ Parameters
411412
<b>Default:</b><br/><div style="color: blue">"yes"</div>
412413
</td>
413414
<td>
414-
<div>If <code>no</code>, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.</div>
415+
<div>If <code>no</code>, SSL certificates will not be validated.</div>
416+
<div>This should only be used on personally controlled sites using a self-signed certificates.</div>
415417
</td>
416418
</tr>
417419
</table>

0 commit comments

Comments
 (0)