Skip to content

Commit 5cf6f49

Browse files
Release v3.0.0 (#463)
1 parent f3e29b9 commit 5cf6f49

File tree

65 files changed

+371
-167
lines changed

Some content is hidden

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

65 files changed

+371
-167
lines changed

.github/workflows/main.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ jobs:
103103
run: poetry install
104104
- name: Build and install collection
105105
run: |
106+
ansible-galaxy collection install community.general -p /home/runner/.ansible/collections
106107
ansible-galaxy collection build .
107108
ansible-galaxy collection install netbox*.tar.gz -p /home/runner/.ansible/collections
108109
- name: Wait for NetBox to be available

CHANGELOG.rst

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

77

8+
v3.0.0
9+
======
10+
11+
Minor Changes
12+
-------------
13+
14+
- Allow rack to be in query_param_ids [#443](https://github.com/netbox-community/ansible_modules/pull/443)
15+
- netbox_cable - Add tags option [#455](https://github.com/netbox-community/ansible_modules/pull/455)
16+
- netbox_cluster_type - Add description option [#451](https://github.com/netbox-community/ansible_modules/pull/451)
17+
- netbox_ipam_role - Add description option [#451](https://github.com/netbox-community/ansible_modules/pull/451)
18+
- netbox_manufacturer - Add description option [#451](https://github.com/netbox-community/ansible_modules/pull/451)
19+
- netbox_rir - Add description option [#451](https://github.com/netbox-community/ansible_modules/pull/451)
20+
- netbox_tenant_group - Add parent_tenant_group option [#460](https://github.com/netbox-community/ansible_modules/pull/460)
21+
22+
Bugfixes
23+
--------
24+
25+
- Remove ansible.netcommon and community.general dependencies from collection
26+
827
v2.1.0
928
======
1029

changelogs/changelog.yaml

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -304,18 +304,17 @@ releases:
304304
0.3.0:
305305
changes:
306306
breaking_changes:
307-
- "To pass in integers via Ansible Jinja filters for a key in ``data`` that\n\
308-
requires querying an endpoint is now done by making it a dictionary with\n\
309-
an ``id`` key. The previous behavior was to just pass in an integer and\n\
310-
it was converted when normalizing the data, but some people may have names\n\
311-
that are all integers and those were being converted erroneously so we made\n\
312-
the decision to change the method to convert to an integer for the NetBox\n\
313-
API.\n\n::\n\n tasks:\n - name: Create device within NetBox with only\
314-
\ required information\n netbox_device:\n netbox_url: http://netbox-demo.org:32768\n\
315-
\ netbox_token: 0123456789abcdef0123456789abcdef01234567\n data:\n\
316-
\ name: Test66\n device_type:\n id: \"{{ some_jinja_variable\
317-
\ }}\"\n device_role: Core Switch\n site: Test Site\n \
318-
\ status: Staged\n state: present\n"
307+
- "To pass in integers via Ansible Jinja filters for a key in ``data`` that\nrequires
308+
querying an endpoint is now done by making it a dictionary with\nan ``id``
309+
key. The previous behavior was to just pass in an integer and\nit was converted
310+
when normalizing the data, but some people may have names\nthat are all integers
311+
and those were being converted erroneously so we made\nthe decision to change
312+
the method to convert to an integer for the NetBox\nAPI.\n\n::\n\n tasks:\n
313+
\ - name: Create device within NetBox with only required information\n netbox_device:\n
314+
\ netbox_url: http://netbox-demo.org:32768\n netbox_token: 0123456789abcdef0123456789abcdef01234567\n
315+
\ data:\n name: Test66\n device_type:\n id:
316+
\"{{ some_jinja_variable }}\"\n device_role: Core Switch\n site:
317+
Test Site\n status: Staged\n state: present\n"
319318
- '``pynetbox`` changed to using ``requests.Session()`` to manage the HTTP session
320319
321320
which broke passing in ``ssl_verify`` when building the NetBox API client.
@@ -481,3 +480,18 @@ releases:
481480
fragments:
482481
- 2.1.0.yml
483482
release_date: '2021-02-15'
483+
3.0.0:
484+
changes:
485+
bugfixes:
486+
- Remove ansible.netcommon and community.general dependencies from collection
487+
minor_changes:
488+
- Allow rack to be in query_param_ids [#443](https://github.com/netbox-community/ansible_modules/pull/443)
489+
- netbox_cable - Add tags option [#455](https://github.com/netbox-community/ansible_modules/pull/455)
490+
- netbox_cluster_type - Add description option [#451](https://github.com/netbox-community/ansible_modules/pull/451)
491+
- netbox_ipam_role - Add description option [#451](https://github.com/netbox-community/ansible_modules/pull/451)
492+
- netbox_manufacturer - Add description option [#451](https://github.com/netbox-community/ansible_modules/pull/451)
493+
- netbox_rir - Add description option [#451](https://github.com/netbox-community/ansible_modules/pull/451)
494+
- netbox_tenant_group - Add parent_tenant_group option [#460](https://github.com/netbox-community/ansible_modules/pull/460)
495+
fragments:
496+
- release-3.0.0.yml
497+
release_date: '2021-03-08'

docs/plugins/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Netbox.Netbox
66
=============
77

8-
Collection version 2.0.0
8+
Collection version 3.0.0
99

1010
.. toctree::
1111
:maxdepth: 1

docs/plugins/nb_inventory_inventory.rst

Lines changed: 22 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 2.0.0).
23+
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
2424

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

@@ -66,6 +66,27 @@ Parameters
6666
</tr>
6767
<tr>
6868
<td colspan="1">
69+
<div class="ansibleOptionAnchor" id="parameter-ansible_host_dns_name"></div>
70+
<b>ansible_host_dns_name</b>
71+
<a class="ansibleOptionLink" href="#parameter-ansible_host_dns_name" title="Permalink to this option"></a>
72+
<div style="font-size: small">
73+
<span style="color: purple">boolean</span>
74+
</div>
75+
</td>
76+
<td>
77+
<ul style="margin: 0; padding: 0"><b>Choices:</b>
78+
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
79+
<li>yes</li>
80+
</ul>
81+
</td>
82+
<td>
83+
</td>
84+
<td>
85+
<div>If True, sets DNS Name (fetched from primary_ip) to be used in ansible_host variable, instead of IP Address.</div>
86+
</td>
87+
</tr>
88+
<tr>
89+
<td colspan="1">
6990
<div class="ansibleOptionAnchor" id="parameter-api_endpoint"></div>
7091
<b>api_endpoint</b>
7192
<a class="ansibleOptionLink" href="#parameter-api_endpoint" title="Permalink to this option"></a>

docs/plugins/nb_lookup_lookup.rst

Lines changed: 1 addition & 1 deletion
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 2.0.0).
23+
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
2424

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

docs/plugins/netbox_aggregate_module.rst

Lines changed: 1 addition & 1 deletion
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 2.0.0).
23+
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
2424

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

docs/plugins/netbox_cable_module.rst

Lines changed: 19 additions & 1 deletion
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 2.0.0).
23+
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
2424

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

@@ -175,6 +175,22 @@ Parameters
175175
<td>
176176
<div>The status of the cable</div>
177177
</td>
178+
</tr>
179+
<tr>
180+
<td class="elbow-placeholder"></td>
181+
<td colspan="1">
182+
<div class="ansibleOptionAnchor" id="parameter-data/tags"></div>
183+
<b>tags</b>
184+
<a class="ansibleOptionLink" href="#parameter-data/tags" title="Permalink to this option"></a>
185+
<div style="font-size: small">
186+
<span style="color: purple">list</span>
187+
/ <span style="color: purple">elements=string</span> </div>
188+
</td>
189+
<td>
190+
</td>
191+
<td>
192+
<div>Any tags that the cable may need to be associated with</div>
193+
</td>
178194
</tr>
179195
<tr>
180196
<td class="elbow-placeholder"></td>
@@ -446,6 +462,8 @@ Examples
446462
color: abcdef
447463
length: 30
448464
length_unit: m
465+
tags:
466+
- foo
449467
state: present
450468

451469
- name: Delete cable within netbox

docs/plugins/netbox_circuit_module.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ netbox.netbox.netbox_circuit -- Create, update or delete circuits 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 2.0.0).
23+
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
2424

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

docs/plugins/netbox_circuit_termination_module.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ netbox.netbox.netbox_circuit_termination -- Create, update or delete circuit ter
2020
.. Collection note
2121
2222
.. note::
23-
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 2.0.0).
23+
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
2424

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

docs/plugins/netbox_circuit_type_module.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ netbox.netbox.netbox_circuit_type -- Create, update or delete circuit types with
2020
.. Collection note
2121
2222
.. note::
23-
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 2.0.0).
23+
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
2424

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

docs/plugins/netbox_cluster_group_module.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ netbox.netbox.netbox_cluster_group -- Create, update or delete cluster groups wi
2020
.. Collection note
2121
2222
.. note::
23-
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 2.0.0).
23+
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
2424

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

docs/plugins/netbox_cluster_module.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ netbox.netbox.netbox_cluster -- Create, update or delete clusters 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 2.0.0).
23+
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
2424

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

docs/plugins/netbox_cluster_type_module.rst

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ netbox.netbox.netbox_cluster_type -- Create, update or delete cluster types with
2020
.. Collection note
2121
2222
.. note::
23-
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 2.0.0).
23+
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
2424

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

@@ -88,6 +88,22 @@ Parameters
8888
<tr>
8989
<td class="elbow-placeholder"></td>
9090
<td colspan="1">
91+
<div class="ansibleOptionAnchor" id="parameter-data/description"></div>
92+
<b>description</b>
93+
<a class="ansibleOptionLink" href="#parameter-data/description" title="Permalink to this option"></a>
94+
<div style="font-size: small">
95+
<span style="color: purple">string</span>
96+
</div>
97+
</td>
98+
<td>
99+
</td>
100+
<td>
101+
<div>The description of the cluster type</div>
102+
</td>
103+
</tr>
104+
<tr>
105+
<td class="elbow-placeholder"></td>
106+
<td colspan="1">
91107
<div class="ansibleOptionAnchor" id="parameter-data/name"></div>
92108
<b>name</b>
93109
<a class="ansibleOptionLink" href="#parameter-data/name" title="Permalink to this option"></a>

docs/plugins/netbox_console_port_module.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ netbox.netbox.netbox_console_port -- Create, update or delete console ports with
2020
.. Collection note
2121
2222
.. note::
23-
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 2.0.0).
23+
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
2424

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

docs/plugins/netbox_console_port_template_module.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ netbox.netbox.netbox_console_port_template -- Create, update or delete console p
2020
.. Collection note
2121
2222
.. note::
23-
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 2.0.0).
23+
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
2424

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

docs/plugins/netbox_console_server_port_module.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ netbox.netbox.netbox_console_server_port -- Create, update or delete console ser
2020
.. Collection note
2121
2222
.. note::
23-
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 2.0.0).
23+
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
2424

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

docs/plugins/netbox_console_server_port_template_module.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ netbox.netbox.netbox_console_server_port_template -- Create, update or delete co
2020
.. Collection note
2121
2222
.. note::
23-
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 2.0.0).
23+
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
2424

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

docs/plugins/netbox_device_bay_module.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ netbox.netbox.netbox_device_bay -- Create, update or delete device bays within N
2020
.. Collection note
2121
2222
.. note::
23-
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 2.0.0).
23+
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
2424

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

docs/plugins/netbox_device_bay_template_module.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ netbox.netbox.netbox_device_bay_template -- Create, update or delete device bay
2020
.. Collection note
2121
2222
.. note::
23-
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 2.0.0).
23+
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
2424

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

docs/plugins/netbox_device_interface_module.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ netbox.netbox.netbox_device_interface -- Creates or removes interfaces on device
2020
.. Collection note
2121
2222
.. note::
23-
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 2.0.0).
23+
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
2424

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

docs/plugins/netbox_device_interface_template_module.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ netbox.netbox.netbox_device_interface_template -- Creates or removes interfaces
2020
.. Collection note
2121
2222
.. note::
23-
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 2.0.0).
23+
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
2424

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

docs/plugins/netbox_device_module.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ netbox.netbox.netbox_device -- Create, update or delete devices 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 2.0.0).
23+
This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
2424

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

0 commit comments

Comments
 (0)