Skip to content

Commit 3679960

Browse files
ryanmerolleryanmerolle
authored
Release v3.1.2 (#594)
* bump galaxy.yml version * update README with regards to Maintainers * generate doc updates with antsibull-docs * Update Changelog using antsibull-changelog * update missing nb_inventory doc
1 parent 1ac7e4d commit 3679960

File tree

61 files changed

+1157
-101
lines changed

Some content is hidden

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

61 files changed

+1157
-101
lines changed

‎CHANGELOG.rst

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

77

8+
v3.1.2
9+
======
10+
11+
Release Summary
12+
---------------
13+
14+
This release focuses on ansible-core 2.11 compatibility, general CI fixes for NetBox 2.10-2.11, and doc updates.
15+
This release works with NetBox 3.0, but needs further investigation with regards to idopmentcy (nothing really major) & some CI.
16+
The next release will idenify and resolve any issues with NetBox 3.0.
17+
18+
Minor Changes
19+
-------------
20+
21+
- Add ansible-core support - Quick fix to support ansible-core 2.11 [#558](https://github.com/netbox-community/ansible_modules/pull/558)
22+
- Add private_key option to nb_lookup for secret decryption [#532](https://github.com/netbox-community/ansible_modules/pull/532)
23+
- Added custom certificate support [#534](https://github.com/netbox-community/ansible_modules/pull/534)
24+
- CI testing & integration tests now leverage ansible-core 2.11 - Fixes #583: Move to Ansible-core for CI tests [#591](https://github.com/netbox-community/ansible_modules/pull/591)
25+
- Correct Invalid NetBox readthedocs URL in nb_inventory docs [#568](https://github.com/netbox-community/ansible_modules/pull/568)
26+
- Fixes to CI due to not pinning NetBox & NetBox-Docker version CI among other minor CI corrections - General CI Fix [573](https://github.com/netbox-community/ansible_modules/pull/573)
27+
- README: Slack link and tidyup [#584](https://github.com/netbox-community/ansible_modules/pull/584)
28+
- Release v3.1.2 [#594](https://github.com/netbox-community/ansible_modules/pull/594)
29+
- Update netbox_region documentation - Documentation: netbox_region - Correct examples [#548](https://github.com/netbox-community/ansible_modules/pull/548)
30+
831
v3.1.1
932
======
1033

‎README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33
![Release](https://img.shields.io/github/v/release/netbox-community/ansible_modules)
44
[![Talk to us: Slack](https://img.shields.io/badge/Slack-blue.svg)](https://netdev-community.slack.com/join/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ#/shared-invite/email)
55

6+
# Looking for New Maintainers
7+
8+
We are in search of a few maintainers for this project. Please see discussion [Looking for maintainers](https://github.com/netbox-community/ansible_modules/discussions/526). Our previous single maintainer was unable to keep up with the project to the high bar set by @FragmentedPacket. The reality is that this is not a project that should be held by a single maintainer. Reach out in the discussion or on our slack if you are interested in helping out.
9+
10+
While we look for maintainers who have shown a willingness to provide inputs/ides, contribute code, and review contributions, the netbox-community team will do its best to maintain this repo in the interim. Prioritization will given to bug fixes, NetBox compatibility, and Ansible requirements/compatibility. New features (associated to the project or NetBox core)will be developed as a best effort, but rest assured, no releases will be cut that are not stable and tested.
611

712
# NetBox modules for Ansible using Ansible Collections
813

‎changelogs/changelog.yaml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -537,3 +537,20 @@ releases:
537537
fragments:
538538
- 3.1.1.yml
539539
release_date: '2021-05-18'
540+
3.1.2:
541+
changes:
542+
minor_changes:
543+
- "Release v3.1.2 [#594](https://github.com/netbox-community/ansible_modules/pull/594)"
544+
- "CI testing & integration tests now leverage ansible-core 2.11 - Fixes #583: Move to Ansible-core for CI tests [#591](https://github.com/netbox-community/ansible_modules/pull/591)"
545+
- "README: Slack link and tidyup [#584](https://github.com/netbox-community/ansible_modules/pull/584)"
546+
- "Fixes to CI due to not pinning NetBox & NetBox-Docker version CI among other minor CI corrections - General CI Fix [573](https://github.com/netbox-community/ansible_modules/pull/573)"
547+
- "Correct Invalid NetBox readthedocs URL in nb_inventory docs [#568](https://github.com/netbox-community/ansible_modules/pull/568)"
548+
- "Add ansible-core support - Quick fix to support ansible-core 2.11 [#558](https://github.com/netbox-community/ansible_modules/pull/558)"
549+
- "Update netbox_region documentation - Documentation: netbox_region - Correct examples [#548](https://github.com/netbox-community/ansible_modules/pull/548)"
550+
- "Added custom certificate support [#534](https://github.com/netbox-community/ansible_modules/pull/534)"
551+
- "Add private_key option to nb_lookup for secret decryption [#532](https://github.com/netbox-community/ansible_modules/pull/532)"
552+
release_summary:
553+
"This release focuses on ansible-core 2.11 compatibility, general CI fixes for NetBox 2.10-2.11, and doc updates.
554+
\nThis release works with NetBox 3.0, but needs further investigation with regards to idopmentcy (nothing really major) & some CI.
555+
\nThe next release will idenify and resolve any issues with NetBox 3.0."
556+
release_date: '2021-09-20'

‎docs/plugins/index.rst

Lines changed: 64 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
:orphan:
21

32
.. _plugins_in_netbox.netbox:
43

54
Netbox.Netbox
65
=============
76

8-
Collection version 3.1.1
7+
Collection version 3.1.2
98

109
.. toctree::
1110
:maxdepth: 1
1211

12+
1313
Plugin Index
1414
------------
1515

@@ -84,6 +84,67 @@ Modules
8484
* :ref:`netbox_vrf <ansible_collections.netbox.netbox.netbox_vrf_module>` -- Create, update or delete vrfs within Netbox
8585

8686

87+
8788
.. seealso::
8889

89-
List of :ref:`collections <list_of_collections>` with docs hosted here.
90+
List of :ref:`collections <list_of_collections>` with docs hosted here.
91+
92+
.. toctree::
93+
:maxdepth: 1
94+
:hidden:
95+
96+
nb_inventory_inventory
97+
nb_lookup_lookup
98+
netbox_aggregate_module
99+
netbox_cable_module
100+
netbox_circuit_module
101+
netbox_circuit_termination_module
102+
netbox_circuit_type_module
103+
netbox_cluster_module
104+
netbox_cluster_group_module
105+
netbox_cluster_type_module
106+
netbox_console_port_module
107+
netbox_console_port_template_module
108+
netbox_console_server_port_module
109+
netbox_console_server_port_template_module
110+
netbox_device_module
111+
netbox_device_bay_module
112+
netbox_device_bay_template_module
113+
netbox_device_interface_module
114+
netbox_device_interface_template_module
115+
netbox_device_role_module
116+
netbox_device_type_module
117+
netbox_front_port_module
118+
netbox_front_port_template_module
119+
netbox_inventory_item_module
120+
netbox_ip_address_module
121+
netbox_ipam_role_module
122+
netbox_manufacturer_module
123+
netbox_platform_module
124+
netbox_power_feed_module
125+
netbox_power_outlet_module
126+
netbox_power_outlet_template_module
127+
netbox_power_panel_module
128+
netbox_power_port_module
129+
netbox_power_port_template_module
130+
netbox_prefix_module
131+
netbox_provider_module
132+
netbox_rack_module
133+
netbox_rack_group_module
134+
netbox_rack_role_module
135+
netbox_rear_port_module
136+
netbox_rear_port_template_module
137+
netbox_region_module
138+
netbox_rir_module
139+
netbox_route_target_module
140+
netbox_service_module
141+
netbox_site_module
142+
netbox_tag_module
143+
netbox_tenant_module
144+
netbox_tenant_group_module
145+
netbox_virtual_chassis_module
146+
netbox_virtual_machine_module
147+
netbox_vlan_module
148+
netbox_vlan_group_module
149+
netbox_vm_interface_module
150+
netbox_vrf_module

‎docs/plugins/nb_inventory_inventory.rst

Lines changed: 117 additions & 2 deletions
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.1.1).
23+
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.1.2).
2424

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

@@ -104,6 +104,24 @@ Parameters
104104
<td>
105105
<div>Endpoint of the NetBox API</div>
106106
</td>
107+
</tr>
108+
<tr>
109+
<td colspan="1">
110+
<div class="ansibleOptionAnchor" id="parameter-ca_path"></div>
111+
<b>ca_path</b>
112+
<a class="ansibleOptionLink" href="#parameter-ca_path" title="Permalink to this option"></a>
113+
<div style="font-size: small">
114+
<span style="color: purple">string</span>
115+
</div>
116+
</td>
117+
<td>
118+
<b>Default:</b><br/><div style="color: blue">"no"</div>
119+
</td>
120+
<td>
121+
</td>
122+
<td>
123+
<div>CA path</div>
124+
</td>
107125
</tr>
108126
<tr>
109127
<td colspan="1">
@@ -260,6 +278,24 @@ Parameters
260278
<td>
261279
<div>Cache duration in seconds</div>
262280
</td>
281+
</tr>
282+
<tr>
283+
<td colspan="1">
284+
<div class="ansibleOptionAnchor" id="parameter-cert"></div>
285+
<b>cert</b>
286+
<a class="ansibleOptionLink" href="#parameter-cert" title="Permalink to this option"></a>
287+
<div style="font-size: small">
288+
<span style="color: purple">string</span>
289+
</div>
290+
</td>
291+
<td>
292+
<b>Default:</b><br/><div style="color: blue">"no"</div>
293+
</td>
294+
<td>
295+
</td>
296+
<td>
297+
<div>Certificate path</div>
298+
</td>
263299
</tr>
264300
<tr>
265301
<td colspan="1">
@@ -582,6 +618,24 @@ Parameters
582618
<td>
583619
<div>If True, it adds the device or virtual machine interface information in host vars.</div>
584620
</td>
621+
</tr>
622+
<tr>
623+
<td colspan="1">
624+
<div class="ansibleOptionAnchor" id="parameter-key"></div>
625+
<b>key</b>
626+
<a class="ansibleOptionLink" href="#parameter-key" title="Permalink to this option"></a>
627+
<div style="font-size: small">
628+
<span style="color: purple">string</span>
629+
</div>
630+
</td>
631+
<td>
632+
<b>Default:</b><br/><div style="color: blue">"no"</div>
633+
</td>
634+
<td>
635+
</td>
636+
<td>
637+
<div>Certificate key path</div>
638+
</td>
585639
</tr>
586640
<tr>
587641
<td colspan="1">
@@ -600,6 +654,35 @@ Parameters
600654
<td>
601655
<div>Add hosts to group based on the values of a variable.</div>
602656
</td>
657+
</tr>
658+
<tr>
659+
<td colspan="1">
660+
<div class="ansibleOptionAnchor" id="parameter-leading_separator"></div>
661+
<b>leading_separator</b>
662+
<a class="ansibleOptionLink" href="#parameter-leading_separator" title="Permalink to this option"></a>
663+
<div style="font-size: small">
664+
<span style="color: purple">boolean</span>
665+
</div>
666+
<div style="font-style: italic; font-size: small; color: darkgreen">
667+
added in 2.11 of ansible.builtin
668+
</div>
669+
</td>
670+
<td>
671+
<ul style="margin: 0; padding: 0"><b>Choices:</b>
672+
<li>no</li>
673+
<li><div style="color: blue"><b>yes</b>&nbsp;&larr;</div></li>
674+
</ul>
675+
</td>
676+
<td>
677+
</td>
678+
<td>
679+
<div>Use in conjunction with keyed_groups.</div>
680+
<div>By default, a keyed group that does not have a prefix or a separator provided will have a name that starts with an underscore.</div>
681+
<div>This is because the default prefix is &quot;&quot; and the default separator is &quot;_&quot;.</div>
682+
<div>Set this option to False to omit the leading underscore (or other separator) if no prefix is given.</div>
683+
<div>If the group name is derived from a mapping the separator is still used to concatenate the items.</div>
684+
<div>To not use a separator in the group name at all, set the separator for the keyed group to an empty string instead.</div>
685+
</td>
603686
</tr>
604687
<tr>
605688
<td colspan="1">
@@ -774,6 +857,38 @@ Parameters
774857
<div>NetBox API token to be able to read against NetBox.</div>
775858
<div>This may not be required depending on the NetBox setup.</div>
776859
</td>
860+
</tr>
861+
<tr>
862+
<td colspan="1">
863+
<div class="ansibleOptionAnchor" id="parameter-use_extra_vars"></div>
864+
<b>use_extra_vars</b>
865+
<a class="ansibleOptionLink" href="#parameter-use_extra_vars" title="Permalink to this option"></a>
866+
<div style="font-size: small">
867+
<span style="color: purple">boolean</span>
868+
</div>
869+
<div style="font-style: italic; font-size: small; color: darkgreen">
870+
added in 2.11 of ansible.builtin
871+
</div>
872+
</td>
873+
<td>
874+
<ul style="margin: 0; padding: 0"><b>Choices:</b>
875+
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
876+
<li>yes</li>
877+
</ul>
878+
</td>
879+
<td>
880+
<div> ini entries:
881+
<p>
882+
[inventory_plugins]<br>use_extra_vars = no
883+
</p>
884+
</div>
885+
<div>
886+
env:ANSIBLE_INVENTORY_USE_EXTRA_VARS
887+
</div>
888+
</td>
889+
<td>
890+
<div>Merge extra vars into the available variables for composition (highest precedence).</div>
891+
</td>
777892
</tr>
778893
<tr>
779894
<td colspan="1">
@@ -877,7 +992,7 @@ Examples
877992
- tag: web
878993
- tag: production
879994

880-
# See the NetBox documentation at https://netbox.readthedocs.io/en/latest/api/overview/
995+
# See the NetBox documentation at https://netbox.readthedocs.io/en/stable/rest-api/overview/
881996
# the query_filters work as a logical **OR**
882997
#
883998
# Prefix any custom fields with cf_ and pass the field value with the regular NetBox query string

0 commit comments

Comments
 (0)