Netbox.Netbox Release Notes

v3.2.0

Minor Changes

Bugfixes

v3.1.2

Release Summary

This release focuses on ansible-core 2.11 compatibility, general CI fixes for NetBox 2.10-2.11, and doc updates. This release works with NetBox 3.0, but needs further investigation with regards to idopmentcy (nothing really major) & some CI. The next release will idenify and resolve any issues with NetBox 3.0.

Minor Changes

v3.1.1

Minor Changes

Bugfixes

v3.1.0

Release Summary

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. 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.

Major Changes

  • packages is now a required Python package and gets installed via Ansible 2.10+.

Minor Changes

  • netbox_device_interface - Add label option.

  • netbox_device_interface - Add mark_connected option.

  • netbox_power_panel - Add location option.

  • netbox_rack - Add location option.

  • netbox_vlan_group - Add custom_fields option.

  • netbox_vlan_group - Add description option.

  • netbox_vlan_group - Add scope option.

  • netbox_vlan_group - Add scope_type option.

Bugfixes

  • Allow virtual_chassis to be found via name [#402](https://github.com/netbox-community/ansible_modules/issues/402)

  • Fix mapping between power_outlet_template and power_port_template.

  • inventory - Fix rack-group -> location for NetBox 2.11 changes.

  • inventory - Properly handle interface tags.

  • netbox_tenant - Fix example to match argspec.

v3.0.0

Minor Changes

Bugfixes

  • Remove ansible.netcommon and community.general dependencies from collection

v2.1.0

Minor Changes

  • Inventory - Added ansible_host_dns_name to set ansible_host to dns_name

  • netbox_device_role - Added description option

  • netbox_platform - Added description option

Bugfixes

  • netbox_ip_address - Added assigned_object to ALLOWED_QUERY_PARAMS

v2.0.0

Minor Changes

  • Added import_targets and export_targets options to netbox_vrf

Bugfixes

New Modules

  • netbox.netbox.netbox_route_target - Creates or removes route targets from Netbox

v1.2.1

Bugfixes

v1.2.0

Major Changes

  • nb_inventory - Add dns_name option that adds dns_name to the host when True and device has a primary IP address. (#394)

  • nb_inventory - Add status as a group_by option. (398)

  • nb_inventory - Move around extracted_primary_ip to allow for config_context or custom_field to overwite. (#377)

  • nb_inventory - Services are now a list of integers due to NetBox 2.10 changes. (#396)

  • nb_lookup - Allow ID to be passed in and use .get instead of .filter. (#376)

  • nb_lookup - Allow api_endpoint and token to be found via env. (#391)

Minor Changes

  • nb_inventory - Added status as host_var. (359)

  • nb_inventory - Added documentation for using keyed_groups. (#361)

  • nb_inventory - Allow to use virtual chassis name instead of device name. (#383)

  • nb_lookup - Allow lookup of plugin endpoints. (#360)

  • nb_lookup - Documentation update to show Fully Qualified Collection Name (FQCN). (#355)

  • netbox_service - Add ports option for NetBox 2.10+ and convert port to ports if NetBox 2.9 or lower. (#396)

  • netbox_virtual_machine - Added comments option. (#380)

  • netbox_virtual_machine - Added local_context_data option. (#357)

Bugfixes

  • Version checks were failing due to converting “2.10” to a float made it an integer of 2.1 which broke version related logic. (#396)

  • netbox_device_interface - Fixed copy pasta in documentation. (#371)

  • netbox_ip_address - Updated documentation to show that family option has been deprecated. (#388)

  • netbox_utils - Fixed typo for circuits.circuittermination searches. (#367)

  • netbox_utils - Skip all modifications to query_params when user_query_params is defined. (#389)

  • netbox_vlan - Fixed uniqueness for vlan searches to add group. (#386)

New Modules

  • netbox.netbox.netbox_tag - Creates or removes tags from Netbox

v1.1.0

Minor Changes

Bugfixes

v1.0.2

Bugfixes

v1.0.1

Minor Changes

Bugfixes

v1.0.0

Bugfixes

v0.3.1

Bugfixes

v0.3.0

Minor Changes

Breaking Changes / Porting Guide

  • To pass in integers via Ansible Jinja filters for a key in data that requires querying an endpoint is now done by making it a dictionary with an id key. The previous behavior was to just pass in an integer and it was converted when normalizing the data, but some people may have names that are all integers and those were being converted erroneously so we made the decision to change the method to convert to an integer for the NetBox API.

    tasks:
      - name: Create device within NetBox with only required information
        netbox_device:
          netbox_url: http://netbox-demo.org:32768
          netbox_token: 0123456789abcdef0123456789abcdef01234567
          data:
            name: Test66
            device_type:
              id: "{{ some_jinja_variable }}"
            device_role: Core Switch
            site: Test Site
            status: Staged
          state: present
    
  • pynetbox changed to using requests.Session() to manage the HTTP session which broke passing in ssl_verify when building the NetBox API client. This PR makes pynetbox 5.0.4+ the new required version of pynetbox for the Ansible modules and lookup plugin. (https://github.com/netbox-community/ansible_modules/pull/269)

Bugfixes

New Modules

  • netbox.netbox.netbox_cable - Create, update or delete cables within Netbox

  • netbox.netbox.netbox_device_bay_template - Create, update or delete device bay templates within Netbox

  • netbox.netbox.netbox_device_interface_template - Creates or removes interfaces on devices from Netbox

  • netbox.netbox.netbox_virtual_chassis - Create, update or delete virtual chassis within Netbox

v0.2.3

Minor Changes

Bugfixes

New Modules

  • netbox.netbox.netbox_console_port - Create, update or delete console ports within Netbox

  • netbox.netbox.netbox_console_port_template - Create, update or delete console port templates within Netbox

  • netbox.netbox.netbox_console_server_port - Create, update or delete console server ports within Netbox

  • netbox.netbox.netbox_console_server_port_template - Create, update or delete console server port templates within Netbox

  • netbox.netbox.netbox_front_port - Create, update or delete front ports within Netbox

  • netbox.netbox.netbox_front_port_template - Create, update or delete front port templates within Netbox

  • netbox.netbox.netbox_power_feed - Create, update or delete power feeds within Netbox

  • netbox.netbox.netbox_power_outlet - Create, update or delete power outlets within Netbox

  • netbox.netbox.netbox_power_outlet_template - Create, update or delete power outlet templates within Netbox

  • netbox.netbox.netbox_power_panel - Create, update or delete power panels within Netbox

  • netbox.netbox.netbox_power_port - Create, update or delete power ports within Netbox

  • netbox.netbox.netbox_power_port_template - Create, update or delete power port templates within Netbox

  • netbox.netbox.netbox_rear_port - Create, update or delete rear ports within Netbox

  • netbox.netbox.netbox_rear_port_template - Create, update or delete rear port templates within Netbox

v0.2.2

Minor Changes

Bugfixes

v0.2.1

Minor Changes

Bugfixes

v0.2.0

Minor Changes

Breaking Changes / Porting Guide

Bugfixes

v0.1.10

Bugfixes

v0.1.9

Breaking Changes / Porting Guide

  • This version has a few breaking changes due to new namespace and collection name. I felt it necessary to change the name of the lookup plugin and inventory plugin just not to have a non descriptive namespace call to use them. Below is an example: netbox.netbox.netbox would be used for both inventory plugin and lookup plugin, but in different contexts so no collision will arise, but confusion will. I renamed the lookup plugin to nb_lookup so it will be used with the FQCN netbox.netbox.nb_lookup. The inventory plugin will now be called within an inventory file by netbox.netbox.nb_inventory

Bugfixes

v0.1.8

Bugfixes

v0.1.7

Minor Changes

Bugfixes

v0.1.6

Minor Changes

Bugfixes

v0.1.5

Bugfixes

New Modules

  • netbox.netbox.netbox_service - Creates or removes service from Netbox

v0.1.3

Bugfixes

v0.1.2

Bugfixes

v0.1.1

Bugfixes

v0.1.0

Minor Changes

Breaking Changes / Porting Guide

New Modules

  • netbox.netbox.netbox_aggregate - Creates or removes aggregates from Netbox

  • netbox.netbox.netbox_circuit - Create, update or delete circuits within Netbox

  • netbox.netbox.netbox_circuit_termination - Create, update or delete circuit terminations within Netbox

  • netbox.netbox.netbox_circuit_type - Create, update or delete circuit types within Netbox

  • netbox.netbox.netbox_cluster - Create, update or delete clusters within Netbox

  • netbox.netbox.netbox_cluster_group - Create, update or delete cluster groups within Netbox

  • netbox.netbox.netbox_cluster_type - Create, update or delete cluster types within Netbox

  • netbox.netbox.netbox_device_bay - Create, update or delete device bays within Netbox

  • netbox.netbox.netbox_device_role - Create, update or delete devices roles within Netbox

  • netbox.netbox.netbox_device_type - Create, update or delete device types within Netbox

  • netbox.netbox.netbox_inventory_item - Creates or removes inventory items from Netbox

  • netbox.netbox.netbox_ipam_role - Creates or removes ipam roles from Netbox

  • netbox.netbox.netbox_manufacturer - Create or delete manufacturers within Netbox

  • netbox.netbox.netbox_platform - Create or delete platforms within Netbox

  • netbox.netbox.netbox_provider - Create, update or delete providers within Netbox

  • netbox.netbox.netbox_rack - Create, update or delete racks within Netbox

  • netbox.netbox.netbox_rack_group - Create, update or delete racks groups within Netbox

  • netbox.netbox.netbox_rack_role - Create, update or delete racks roles within Netbox

  • netbox.netbox.netbox_region - Creates or removes regions from Netbox

  • netbox.netbox.netbox_rir - Create, update or delete RIRs within Netbox

  • netbox.netbox.netbox_tenant - Creates or removes tenants from Netbox

  • netbox.netbox.netbox_tenant_group - Creates or removes tenant groups from Netbox

  • netbox.netbox.netbox_virtual_machine - Create, update or delete virtual_machines within Netbox

  • netbox.netbox.netbox_vlan - Create, update or delete vlans within Netbox

  • netbox.netbox.netbox_vlan_group - Create, update or delete vlans groups within Netbox

  • netbox.netbox.netbox_vm_interface - Creates or removes interfaces from virtual machines in Netbox

  • netbox.netbox.netbox_vrf - Create, update or delete vrfs within Netbox