You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.rst
+55-55
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
===========================
2
-
Netbox.Netbox Release Notes
2
+
NetBox.NetBox Release Notes
3
3
===========================
4
4
5
5
.. contents:: Topics
@@ -82,7 +82,7 @@ v3.1.0
82
82
Release Summary
83
83
---------------
84
84
85
-
This release should fix obvious broken changes between collection and Netbox 2.11, but there is most likely more. Please report as they're encountered.
85
+
This release should fix obvious broken changes between collection and NetBox 2.11, but there is most likely more. Please report as they're encountered.
86
86
**packages** is now a required Python package and is already included in Ansible 2.10, but anyone using Ansible 2.9 or below must manually pip install the library.
87
87
88
88
@@ -164,7 +164,7 @@ Bugfixes
164
164
New Modules
165
165
-----------
166
166
167
-
- netbox.netbox.netbox_route_target - Creates or removes route targets from Netbox
167
+
- netbox.netbox.netbox_route_target - Creates or removes route targets from NetBox
168
168
169
169
v1.2.1
170
170
======
@@ -212,7 +212,7 @@ Bugfixes
212
212
New Modules
213
213
-----------
214
214
215
-
- netbox.netbox.netbox_tag - Creates or removes tags from Netbox
215
+
- netbox.netbox.netbox_tag - Creates or removes tags from NetBox
216
216
217
217
v1.1.0
218
218
======
@@ -328,10 +328,10 @@ Bugfixes
328
328
New Modules
329
329
-----------
330
330
331
-
- netbox.netbox.netbox_cable - Create, update or delete cables within Netbox
332
-
- netbox.netbox.netbox_device_bay_template - Create, update or delete device bay templates within Netbox
333
-
- netbox.netbox.netbox_device_interface_template - Creates or removes interfaces on devices from Netbox
334
-
- netbox.netbox.netbox_virtual_chassis - Create, update or delete virtual chassis within Netbox
331
+
- netbox.netbox.netbox_cable - Create, update or delete cables within NetBox
332
+
- netbox.netbox.netbox_device_bay_template - Create, update or delete device bay templates within NetBox
333
+
- netbox.netbox.netbox_device_interface_template - Creates or removes interfaces on devices from NetBox
334
+
- netbox.netbox.netbox_virtual_chassis - Create, update or delete virtual chassis within NetBox
335
335
336
336
v0.2.3
337
337
======
@@ -355,20 +355,20 @@ Bugfixes
355
355
New Modules
356
356
-----------
357
357
358
-
- netbox.netbox.netbox_console_port - Create, update or delete console ports within Netbox
359
-
- netbox.netbox.netbox_console_port_template - Create, update or delete console port templates within Netbox
360
-
- netbox.netbox.netbox_console_server_port - Create, update or delete console server ports within Netbox
361
-
- netbox.netbox.netbox_console_server_port_template - Create, update or delete console server port templates within Netbox
362
-
- netbox.netbox.netbox_front_port - Create, update or delete front ports within Netbox
363
-
- netbox.netbox.netbox_front_port_template - Create, update or delete front port templates within Netbox
364
-
- netbox.netbox.netbox_power_feed - Create, update or delete power feeds within Netbox
365
-
- netbox.netbox.netbox_power_outlet - Create, update or delete power outlets within Netbox
366
-
- netbox.netbox.netbox_power_outlet_template - Create, update or delete power outlet templates within Netbox
367
-
- netbox.netbox.netbox_power_panel - Create, update or delete power panels within Netbox
368
-
- netbox.netbox.netbox_power_port - Create, update or delete power ports within Netbox
369
-
- netbox.netbox.netbox_power_port_template - Create, update or delete power port templates within Netbox
370
-
- netbox.netbox.netbox_rear_port - Create, update or delete rear ports within Netbox
371
-
- netbox.netbox.netbox_rear_port_template - Create, update or delete rear port templates within Netbox
358
+
- netbox.netbox.netbox_console_port - Create, update or delete console ports within NetBox
359
+
- netbox.netbox.netbox_console_port_template - Create, update or delete console port templates within NetBox
360
+
- netbox.netbox.netbox_console_server_port - Create, update or delete console server ports within NetBox
361
+
- netbox.netbox.netbox_console_server_port_template - Create, update or delete console server port templates within NetBox
362
+
- netbox.netbox.netbox_front_port - Create, update or delete front ports within NetBox
363
+
- netbox.netbox.netbox_front_port_template - Create, update or delete front port templates within NetBox
364
+
- netbox.netbox.netbox_power_feed - Create, update or delete power feeds within NetBox
365
+
- netbox.netbox.netbox_power_outlet - Create, update or delete power outlets within NetBox
366
+
- netbox.netbox.netbox_power_outlet_template - Create, update or delete power outlet templates within NetBox
367
+
- netbox.netbox.netbox_power_panel - Create, update or delete power panels within NetBox
368
+
- netbox.netbox.netbox_power_port - Create, update or delete power ports within NetBox
369
+
- netbox.netbox.netbox_power_port_template - Create, update or delete power port templates within NetBox
370
+
- netbox.netbox.netbox_rear_port - Create, update or delete rear ports within NetBox
371
+
- netbox.netbox.netbox_rear_port_template - Create, update or delete rear port templates within NetBox
372
372
373
373
v0.2.2
374
374
======
@@ -469,7 +469,7 @@ v0.1.7
469
469
Minor Changes
470
470
-------------
471
471
472
-
- Added fetching services for devices in Netbox Inventory Plugin (https://github.com/netbox-community/ansible_modules/issues/58)
472
+
- Added fetching services for devices in NetBox Inventory Plugin (https://github.com/netbox-community/ansible_modules/issues/58)
473
473
- Added option for interfaces and IP addresses of interfaces to be fetched via inventory plugin (https://github.com/netbox-community/ansible_modules/issues/60)
474
474
- Change lookups to property for subclassing of inventory plugin (https://github.com/netbox-community/ansible_modules/issues/62)
475
475
@@ -489,13 +489,13 @@ Minor Changes
489
489
-------------
490
490
491
491
- Add dns_name to netbox_ip_address (https://github.com/netbox-community/ansible_modules/issues/84)
492
-
- Add region and region_id to query_filter for Netbox Inventory plugin (https://github.com/netbox-community/ansible_modules/issues/83)
492
+
- Add region and region_id to query_filter for NetBox Inventory plugin (https://github.com/netbox-community/ansible_modules/issues/83)
493
493
494
494
Bugfixes
495
495
--------
496
496
497
497
- Fixed vlan searching with vlan_group for netbox_prefix (https://github.com/netbox-community/ansible_modules/issues/85)
498
-
- Removed static choices from netbox_utils and now pulls the choices for each endpoint from the Netbox API at call time (https://github.com/netbox-community/ansible_modules/issues/67)
498
+
- Removed static choices from netbox_utils and now pulls the choices for each endpoint from the NetBox API at call time (https://github.com/netbox-community/ansible_modules/issues/67)
499
499
500
500
v0.1.5
501
501
======
@@ -506,14 +506,14 @@ Bugfixes
506
506
- Add argument specs for every module to validate data passed in. Fixes some idempotency issues. POSSIBLE BREAKING CHANGE (https://github.com/netbox-community/ansible_modules/issues/68)
507
507
- Allow name updates to manufacturers (https://github.com/netbox-community/ansible_modules/issues/76)
508
508
- Builds slug for netbox_device_type from model which is now required and slug is optional. Model will be slugified if slug is not provided BREAKING CHANGE (https://github.com/netbox-community/ansible_modules/issues/77)
509
-
- Fail module with proper exception when connection to Netbox API cannot be established (https://github.com/netbox-community/ansible_modules/issues/80)
509
+
- Fail module with proper exception when connection to NetBox API cannot be established (https://github.com/netbox-community/ansible_modules/issues/80)
510
510
- netbox_device_interface Lag no longer has to be a dictionary and the value of the key can be the name of the LAG (https://github.com/netbox-community/ansible_modules/issues/81)
511
-
- netbox_ip_address If no address has no CIDR notation, it will convert it into a /32 and pass to Netbox. Fixes idempotency cidr notation is not provided (https://github.com/netbox-community/ansible_modules/issues/78)
511
+
- netbox_ip_address If no address has no CIDR notation, it will convert it into a /32 and pass to NetBox. Fixes idempotency cidr notation is not provided (https://github.com/netbox-community/ansible_modules/issues/78)
512
512
513
513
New Modules
514
514
-----------
515
515
516
-
- netbox.netbox.netbox_service - Creates or removes service from Netbox
516
+
- netbox.netbox.netbox_service - Creates or removes service from NetBox
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+8-8
Original file line number
Diff line number
Diff line change
@@ -2,17 +2,17 @@
2
2
3
3
## Modules
4
4
5
-
The structure of the Netbox modules attempts to follow the layout of the Netbox API by having a module_util for each application (`dcim, ipam, tenancy, etc`) that inherits from a base module (`NetboxModule - netbox_utils.py`) and then implements the specific endpoints within the correct application module.
5
+
The structure of the NetBox modules attempts to follow the layout of the NetBox API by having a module_util for each application (`dcim, ipam, tenancy, etc`) that inherits from a base module (`NetboxModule - netbox_utils.py`) and then implements the specific endpoints within the correct application module.
6
6
7
7
e.g. Add logic for adding devices under netbox_dcim.py or ip addresses under netbox_ipam.py
8
8
9
9
In turn when creating the actual modules, we're just calling a single function and passing in the Ansible Module and the endpoint. This means all the logic is within the specific application's module_util module and a lot of the logic should be the same for most endpoints since it is a basic operation of using the desired state of the endpoint and then either making sure it exists, updating it if it does exist, or removing it. There may be some special logic for other endpoints, but it should be minimal.
These modules are built using the pynetbox Python library which allows you to interact with Netbox using objects. Most of this is abstracted away when creating more modules, but something to be aware of. The reasoning for using underscores within the endpoint names is so the endpoints work with pynetbox.
13
+
These modules are built using the pynetbox Python library which allows you to interact with NetBox using objects. Most of this is abstracted away when creating more modules, but something to be aware of. The reasoning for using underscores within the endpoint names is so the endpoints work with pynetbox.
14
14
15
-
An example of connecting to a Netbox instance and then choosing the application, endpoint, and operation:
15
+
An example of connecting to a NetBox instance and then choosing the application, endpoint, and operation:
16
16
17
17
```python
18
18
import pynetbox
@@ -122,7 +122,7 @@ ENDPOINT_NAME_MAPPING = {
122
122
}
123
123
```
124
124
125
-
Log into your Netbox instance and navigate to `/api/docs` and searching for the **POST** documents for the given endpoint you're looking to create.
125
+
Log into your NetBox instance and navigate to `/api/docs` and searching for the **POST** documents for the given endpoint you're looking to create.
126
126
127
127
The module should implement all available fields that are not the **id** or **readOnly** such as the **created, last_updated, device_count** in the example above.
Used to change non-clashing keys for each module into identical keys that are required
241
241
to be passed to pynetbox
242
-
ex. rack_role back into role to pass to Netbox
242
+
ex. rack_role back into role to pass to NetBox
243
243
Returns data
244
244
:params data (dict): Data dictionary after _find_ids method ran
245
245
"""
@@ -293,7 +293,7 @@ Copying an existing module that has close to the same options is typically the p
293
293
```
294
294
295
295
- Check each test above to see which `test_data` it uses and edit the corresponding data.json file
296
-
- Please add or update an existing play to test the new Netbox module for integration testing within `tests/integration/integration-tests.yml`. Make sure to test creation, duplicate, update (if possible), and deletion along with any other conditions that may want to be tested.
296
+
- Please add or update an existing play to test the new NetBox module for integration testing within `tests/integration/integration-tests.yml`. Make sure to test creation, duplicate, update (if possible), and deletion along with any other conditions that may want to be tested.
297
297
- Run `pytest -vv` to make sure all unit tests pass
298
298
- Run `black .` within the base directory for black formatting as it's required for tests to pass
299
299
- Run `ansible-lint integration-tests.yml` it's required for tests to pass
@@ -306,7 +306,7 @@ Integration tests are run by comparing `ansible-inventory --list` against known
306
306
307
307
When the inventory plugin is updated in a way that changes this output (or `netbox-deploy.py` is changed), the test data used for comparison will need to be updated. There is a script `./hacking/update_test_inventories.sh` to do this.
308
308
309
-
Run from the root project working directory, and make sure you have a clean test instance of Netbox set up with test data loaded into it from `./tests/integration/netbox-deploy.py`
309
+
Run from the root project working directory, and make sure you have a clean test instance of NetBox set up with test data loaded into it from `./tests/integration/netbox-deploy.py`
310
310
311
311
```
312
312
./hacking/update_test_inventories.sh
@@ -319,7 +319,7 @@ After running the script, to prevent introducing a regression you'll need to man
319
319
320
320
You can see the specific details of what happens in CI in `.travis.yml`. An overview of what you need to do is:
321
321
322
-
* Run a test instance of Netbox on port 32768. The `netbox-docker` project makes this easy.
322
+
* Run a test instance of NetBox on port 32768. The `netbox-docker` project makes this easy.
0 commit comments