ENHANCEMENTS
- New Data Source:
netbox_device_interfaces
(#476 by @w87x) - resource/netbox_token: Add
description
attribute (#473 by @twink0r) - data-source/netbox_virtual_machines: Include
device_id
anddevice_name
attributes in result (#477 by @zeddD1abl0)
BREAKING CHANGES
- resource/netbox_custom_field: Replace
choices
attribute withchoice_set_id
attribute
ENHANCEMENTS
- provider: Now officially supports NetBox 3.6
- New Resource:
netbox_custom_field_choice_set
FEATURES
- New Data Source:
netbox_location
(#467 by @w87x) - data-source/netbox_virtual_machines: Allow searching by tag (#466 by @twink0r)
- resource/netbox_device: Add
asset_tag
attribute (#470 by @bebehei) - resource/netbox_device_interface: Add
speed
,lag_device_interface_id
andparent_device_interface_id
attributes (#469 by @bebehei)
BUG FIXES
- resource/netbox_custom_field: Allow correct value
json
instead ofJSON
(#459 by @menselman)
FEATURES
- New Resource:
netbox_webhook
(#438 by @haipersuccor02)
BREAKING CHANGES
Due to a change in NetBox 3.5's behavior regarding ASN and the corresponding required changes in the go library that is used in this provider,
the netbox_asn
resource and the netbox_asns
data source are no longer supported in versions older than 3.5.
For all other resources and data sources, the provider should still perform fine with older NetBox versions.
ENHANCEMENTS
- provider: Now officially supports NetBox 3.5
ENHANCEMENTS
- data-source/netbox_cluster: Allow searching by
id
field and includecustom_fields
attribute in output (#457 by @fred-clement-91)
BUG FIXES
- resource/netbox_device_interface: Changing
mac_address
no longer needlessly forces a recreate of the resource (#454 by @hamzazaman)
FEATURES
- New Resource:
netbox_cable
(#450 by @joeyberkovitz) - New Resource:
netbox_device_console_port
(#450 by @joeyberkovitz) - New Resource:
netbox_device_console_server_port
(#450 by @joeyberkovitz) - New Resource:
netbox_device_power_port
(#450 by @joeyberkovitz) - New Resource:
netbox_device_power_outlet
(#450 by @joeyberkovitz) - New Resource:
netbox_device_front_port
(#450 by @joeyberkovitz) - New Resource:
netbox_device_rear_port
(#450 by @joeyberkovitz) - New Resource:
netbox_device_module_bay
(#450 by @joeyberkovitz) - New Resource:
netbox_module
(#450 by @joeyberkovitz) - New Resource:
netbox_module_type
(#450 by @joeyberkovitz) - New Resource:
netbox_power_feed
(#450 by @joeyberkovitz) - New Resource:
netbox_power_panel
(#450 by @joeyberkovitz) - New Resource:
netbox_inventory_item_role
(#450 by @joeyberkovitz) - New Resource:
netbox_inventory_item
(#450 by @joeyberkovitz)
ENHANCEMENTS
- resource/netbox_service: Add
custom_fields
attribute (#448 by @sebastianreloaded) - data-source/netbox_site: Allow searching by
id
field
BUG FIXES
- resource/netbox_interface: Allow setting
enabled
tofalse
- resource/netbox_device_interface: Allow setting
enabled
tofalse
FEATURES
ENHANCEMENTS
- Added
description
attribute to - data-source/netbox_devices: Return
tags
attribute - resource/netbox_interface: Ignore drift when providing lowercase MAC addresses (#446 by @bebehei)
- resource/netbox_device_interface: Ignore drift when providing lowercase MAC addresses (#446 by @bebehei)
BUG FIXES
- resource/netbox_ip_address: Use correct attribute when using the
device_interface_id
attribute (#437 by @switchcorp) - resource/netbox_primary_ip: Fix a bug where setting a primary IP unsets the
local_context_data
attribute (#435 by @tagur87)
BREAKING CHANGES
Historically, this provider primarily handled virtual machines, so when linking a netbox_ip_address
resource to an interface, the interface was initially assumed to always be a virtual machine interface. In v3.1.0, support was added for device interfaces by setting the newly introduced object_type
attribute, once again defaulting to virtual machine interfaces. The valid values for object_type
directly reflect the API values of NetBox, which are very unintuitive.
In this version, we make the type of connection between IP addresses and interfaces explicit: We introduce two new attributes: virtual_machine_interface_id
and device_interface_id
to the netbox_ip_address
resource. These fields are easier to use and convey their meaning directly to the user. The object_type
and interface_id
method is still supported, but object_type
no longer has a default value and is now mandatory when interface_id
is used.
Migration guide
In your existing codebase:
- replace
interface_id
withvirtual_machine_interface_id
ifobject_type
is currently unset or set tovirtualization.vminterface
- replace
interface_id
withdevice_interface_id
ifobject_type
is currently set todcim.interface
ENHANCEMENTS
- resource/netbox_ip_address: Add
virtual_machine_interface_id
anddevice_interface_id
attributes - resource/netbox_ip_address: Add
slaac
to the list of valid statuses - resource/netbox_ip_address: Add
nat_inside_address_id
andnat_outside_addresses
attributes
BUG FIXES
ENHANCEMENTS
- resource/netbox_cluster: Add
comments
attribute (#429 by @edwin-bruurs) - data-source/netbox_prefix: Add
family
attribute (#431 by @tagur87)
BUG FIXES
- resource/netbox_virtual_machine: Fix
local_context_data
attribute (#430 by @zeddD1abl0)
ENHANCEMENTS
- New Resource:
netbox_device_primary_ip
(#424 by @Ikke) - resource/netbox_virtual_machine: Add
local_context_data
attribute (#421 by @zeddD1abl0)
BUG FIXES
- resource/netbox_primary_ip: Fix a bug where setting the primary ip of a VM unsets the device id
ENHANCEMENTS
- New Data Source:
netbox_vlans
(#420 by @danischm) - resource/netbox_contact_assignment: Add
priority
attribute (#418 by @Ikke)
ENHANCEMENTS
ENHANCEMENTS
- data-source/netbox_prefixes: Allow filtering by
site_id
(#397 by @tagur87) - data-source/netbox_ip_addresses: Add
tags
attributes to output (#406 by @pier-nl) - Improved error handling for tags (#400 by @tagur87)
ENHANCEMENTS
- New Resource:
netbox_permission
(#390 by @tagur87) - New Resource:
netbox_contact_group
(#366 by @leasley199) - New Data Source:
netbox_contact_group
(#366 by @leasley199) - New Data Source:
netbox_contact
(#366 by @leasley199) - data-source/netbox_cluster: Allow searching by
site_id
BUG FIXES
ENHANCEMENTS
- New Resource:
netbox_vlan_group
(#377 by @zeddD1abl0) - New Data Source:
netbox_vlan_group
(#377 by @zeddD1abl0) - resource/netbox_vlan: Add
group_id
attribute (#377 by @zeddD1abl0)
BUG FIXES
- data-source/netbox_prefixes: Fix error when filtering by
vlan_vid
(#381 by @zeddD1abl0)
ENHANCEMENTS
- New Resource:
netbox_route_target
(#344 by @imdhruva) - New Resource:
netbox_rack
(#358 by @joeyberkovitz) - New Resource:
netbox_rack_reservation
(#358 by @joeyberkovitz) - New Resource:
netbox_rack_role
(#358 by @joeyberkovitz) - New Data Source:
netbox_ipam_role
(#344 by @imdhruva) - New Data Source:
netbox_route_target
(#344 by @imdhruva) - New Data Source:
netbox_racks
(#358 by @joeyberkovitz) - New Data Source:
netbox_rack_role
(#358 by @joeyberkovitz) - resource/netbox_device: Add
rack_face
,rack_id
andrack_position
attributes (#358 by @joeyberkovitz) - data-source/netbox_device: Add
rack_face
,rack_id
andrack_position
attributes (#358 by @joeyberkovitz) - data-source/netbox_prefixes: Add support for filtering by
status
andtag
(#367 by @kyle-burnett) - resource/netbox_location: Add
description
attribute - resource/netbox_rir: Add
description
attribute - resource/netbox_vrf: Add
description
attribute - data-source/netbox_prefixes: Include
description
attribute in search results - data-source/netbox_ip_addresses: Add
limit
attribute (default 1000)
CHANGES
- provider:
slug
fields are now generated to match the netbox GUI behavior
ENHANCEMENTS
- resource/netbox_interface: Updating
mac_address
no longer forces resource recreation (#336 by @johann8384) - resource/netbox_site: Add
physical_address
andshipping_address
(#337 by @Ikke) - resource/netbox_ip_address: IP addresses can now be assigned to devices via the
object_type
field (#341 by @arjenvri)
ENHANCEMENTS
ENHANCEMENTS
- resource/netbox_token: Add
write_enabled
attribute (#309 by @keshy7) - data-source/netbox_interfaces: The resulting interfaces now have their interface ID set
BUG FIXES
- resource/site: Allow unsetting
description
attribute (#314 by @keshy7) - resource/site: Set max length of the
slug
attribute to 100 (#317 by @keshy7)
ENHANCEMENTS
- resource/netbox_available_ip_address: Add
role
attribute
BUG FIXES
ENHANCEMENTS
- provider: Add
strip_trailing_slashes_from_url
attribute
BUG FIXES
ENHANCEMENTS
- data-source/netbox_vlan: Allow querying by
group_id
,role
andtenant
(#287 by @tstarck) - data-source/netbox_prefix: Allow querying by
description
(#298 by @luispcoutinho)
ENHANCEMENTS
- New Resource:
netbox_device_interface
(#286 by @arjenvri) - New Data Source:
netbox_asn
(#285 by @kyle-burnett) - New Data Source:
netbox_asns
(#292 by @kyle-burnett) - data-source/netbox_prefix: Add
tags
and tag filter attributes (#284 by @kyle-burnett)
BUG FIXES
- data-source/netbox_prefixes: Fix kernel panic when finding prefixes without vlan or vrf
ENHANCEMENTS
- New Resource:
netbox_contact_role
(#279 by @arjenvri) - New Resource:
netbox_contact_assignment
(#279 by @arjenvri) - resource/netbox_device: Add
primary_ipv6
attribute (#282 by @arjenvri) - resource/netbox_virtual_machine: Add
primary_ipv6
attribute (#283 by @arjenvri) - resource/netbox_custom_field: Add
group_name
atribute (#280 by @arjenvri)
ENHANCEMENTS
- New Resource:
netbox_contact
(#273 by @arjenvri) - data-source/netbox_prefix: Add
description
attribute (#277 by @holmesb) - resource/netbox_cluster: Add
tenant_id
attribute (#275 by @arjenvri)
ENHANCEMENTS
- resource/netbox_device_role: Add
tags
attribute (#269 by @hollow) - data-source/netbox_device_role: Add
tags
attribute (#269 by @hollow)
CHANGES
- resource/netbox_service: Implement provider-side validation on allowed values. Valid values are
tcp
,udp
andsctp
.
ENHANCEMENTS
- resource/netbox_device: Add
platform_id
attribute (#264 by @mifrost) - New Data Source:
netbox_prefixes
(#253 by @ironashram) - data-source/netbox_prefix: Add
prefix
,status
,vlan_id
,vlan_vid
attributes (#253 by @ironashram) - resource/netbox_device: Add
status
attribute #266 by @mifrost)
CHANGES
- resource/netbox_prefix: Deprecate
cidr
attribute in favor of new canonicalprefix
attribute
ENHANCEMENTS
ENHANCEMENTS
- data-source/netbox_cluster: Add
site_id
,cluster_type_id
,cluster_group_id
andtags
attribute (#251 by @ns1pelle)
This is a re-release of 3.0.0 because there seem to be some issues with the checksums in the 3.0.0 version.
FEATURES
- provider: Now supports NetBox v3.3
ENHANCEMENTS
- resource/netbox_virtual_machine: In accordance with upstream API changes, VMs can now have
site_id
set directly - resource/netbox_virtual_machine: Add
device_id
attribute (#238 by @ns1pelle) - resource/netbox_circuit_termination: Add
tags
andcustom_fields
attributes (#238 by @ns1pelle) - resource/netbox_token: Add
allowed_ips
,last_used
andexpires
attributes (#238 by @ns1pelle) - resource/netbox_device: Add
cluster_id
attribute (#238 by @ns1pelle)
ENHANCEMENTS
- New Data Source:
netbox_devices
(#236 by @dipeshsharma) - provider: Add
request_timeout
attribute (#227 by @twink0r) - data-source/netbox_tenants: Add
limit
attribute to allow for larger queries
ENHANCEMENTS
- New Resource:
netbox_site_group
- New Data Source:
netbox_site_group
- resource/netbox_virtual_machine: Add
status
attribute. Thestatus
attribute will default toactive
, which matches the implicit behavior of NetBox. If you manually changed the status of your terraform-managed NetBox VMs, be cautious - data-source/netbox_tenant: Allow searching by
slug
attribute
ENHANCEMENTS
- provider: Update list of supported versions
- docs: Add all missing docs and update existing ones
- docs: Add subcategories
ENHANCEMENTS
- resource/netbox_ip_address: Add
role
attribute - resource/netbox_available_ip_address: improve documentation (#220 by @holmesb)
BUG FIXES
- resource/netbox_device: Set correct attribute for
device_type_id
(#219 by @BegBlev) - data-source/netbox_ip_addresses: Use correct attribute for
role
(#217 by @twink0r)
ENHANCEMENTS
- data-source/netbox_prefix: Add
vrf_id
attribute
BUG FIXES
- resource/netbox_prefix: Allow unsetting mark_utilized and is_pool attributes
- resource/netbox_available_prefix: Allow unsetting mark_utilized and is_pool attributes
BUG FIXES
- resource/netbox_device: Make
role_id
andsite_id
attributes mandatory - resource/netbox_device_type: Make
manufacturer_id
attribute mandatory
ENHANCEMENTS
- New Resource:
netbox_location
(#195 by @arjenvri) - resource/netbox_device: Add
location_id
attribute (#195 by @arjenvri)
BREAKING CHANGES
NetBox 3.2.0 came with breaking changes. In accordance with the upstream API, the netbox_site
resource and data source now have an asn_ids
attribute that replaces the asn
attriute. Note that asn_ids
contains IDs of ASN objects, not numbers.
ENHANCEMENTS
- New Resource:
netbox_asn
ENHANCEMENTS
- resource/netbox_site: Make
status
attribute optional and default toactive
(#187 by @tstarck) - data-source/netbox_site: Add
slug
parameter to allow searching for a slug (#187 by @tstarck) - data-source/netbox_site: Include
asn
,slug
,comments
,description
,group_id
,status
,region_id
,tenant_id
andtime_zone
attributes in the search result (#187 by @tstarck) - resource/netbox_vlan: Add default values to
status
anddescription
attributes (#184 by @tstarck) - resource/netbox_interface: Add
enabled
,mtu
,mode
,tagged_vlans
anduntagged_vlans
attributes (#183 by @tstarck)
ENHANCEMENTS
- New Data Source:
netbox_device_type
(#179 by @tstarck) - New Data Source:
netbox_vlan
(#180 by @tstarck) - provider: Add
skip_version_check
attribute - provider: Update list of officially supported versions
- resource/netbox_device_type: Add
part_number
attribute (#179 by @tstarck)
BUG FIXES
- resource/netbox_circuit: Fix bug that prevented updates from being made
- resource/netbox_circuit_provider: Fix bug that prevented updates from being made
ENHANCEMENTS
- docs: Fix critical error in usage documentation
FEATURES
ENHANCEMENTS
- resource/netbox_site: Add
timezone
,latitude
,longitude
andcustom_fields
attributes (#168 by @arjenvri) - docs: Regenerate docs with updated tooling (#165 by @d-strobel)
FEATURES
- New Data Source:
netbox_ip_addresses
(#159 by @twink0r) - New Resource:
netbox_circuit
(#160 by @arjenvri) - New Resource:
netbox_circuit_provider
(#160 by @arjenvri) - New Resource:
netbox_circuit_termination
(#160 by @arjenvri) - New Resource:
netbox_circuit_type
(#160 by @arjenvri) - New Resource:
netbox_custom_field
(#158 by @chapsuk)
ENHANCEMENTS
- resource/netbox_ip_address: Add
description
attribute (#156 by @fbreckle) - resource/netbox_virtual_machine: Add
custom_fields
attribute (#158 by @chapsuk)
FEATURES
ENHANCEMENTS
FEATURES
- New Resource:
netbox_device
(#142 by @arjenvri) - New Resource:
netbox_device_type
(#142 by @arjenvri) - New Resource:
netbox_manufacturer
(#142 by @arjenvri)
ENHANCEMENTS
ENHANCEMENTS
FEATURES
FEATURES
- New Data Source:
netbox_cluster_type
#122 by @madnutter56 - New Data Source:
netbox_site
#122 by @madnutter56
FEATURES
ENHANCEMENTS
- resource/netbox_virtual_machine: Now has a state migration for the
vcpus
attribute (#120 by @pascal-hofmann)
FEATURES
- provider: Can now optionally pass custom HTTP headers for every request (#116 by @mariuskiessling)
FEATURES
ENHANCEMENTS
- resource/netbox_available_ip_address: fixed duplicates #59 (#106 by @holmesb)
- resource/netbox_available_ip_address: Add
description
argument (#106 by @holmesb) - resource/netbox_available_ip_address:
status
argument is now optional (#106 by @holmesb) - resource/netbox_vrf: Add
tenant_id
attribute (#112 by @cova-fe) - data-source/netbox_vrf: Add
tenant_id
attribute (#112 by @cova-fe) - resource/available_prefix: Add
mark_utilized
attribute (#111 by @cova-fe)
FEATURES
- provider: Now supports NetBox v3.1.3
ENHANCEMENTS
FEATURES
- New Resource:
netbox_ip_range
(#101 by @holmesb) - New Data Source:
netbox_ip_range
(#101 by @holmesb)
FEATURES
- provider: Now supports NetBox v3.0.9
BREAKING CHANGES
- resource/virtual_machine:
vcpus
is now a float to match upstream API
ENHANCEMENTS
FEATURES
ENHANCEMENTS
FEATURES
- provider: Now supports NetBox v2.11.12
BREAKING CHANGES
- resource/virtual_machine:
vcpus
is now a string to match upstream API
ENHANCEMENTS
- New Resource:
netbox_site
(#78)
BUG FIXES
- resource/cluster: Properly set tags when updating (#69)
CHANGES
- Use go 1.17 to fix some builds
ENHANCEMENTS
- Add arm64 builds (#71 by @richardklose)
ENHANCEMENTS
ENHANCEMENTS
- resource/prefix: Add
vrf
andtenant
attribute (#61 by @jeansebastienh)
BUG FIXES
- resource/prefix: Correctly read
prefix
andstatus
(#60 by @jeansebastienh)
FEATURES
- provider: Now supports NetBox v2.10.10
CHANGES
- resource/service:
port
field is now deprecated in favor ofports
field.
ENHANCEMENTS
- New Resource:
netbox_tenant_group
(#48 by @pezhore) - New Data Source:
netbox_tenant_group
(#48 by @pezhore) - data-source/tenant: Add
group_id
attribute (#48 by @pezhore)
ENHANCEMENTS
FEATURES
FEATURES
- New Data Source:
netbox_cluster_type
#122 by @madnutter56 - New Data Source:
netbox_site
#122 by @madnutter56
FEATURES
ENHANCEMENTS
- resource/netbox_virtual_machine: Now has a state migration for the
vcpus
attribute (#120 by @pascal-hofmann)
FEATURES
- provider: Can now optionally pass custom HTTP headers for every request (#116 by @mariuskiessling)
FEATURES
ENHANCEMENTS
- resource/netbox_available_ip_address: fixed duplicates #59 (#106 by @holmesb)
- resource/netbox_available_ip_address: Add
description
argument (#106 by @holmesb) - resource/netbox_available_ip_address:
status
argument is now optional (#106 by @holmesb) - resource/netbox_vrf: Add
tenant_id
attribute (#112 by @cova-fe) - data-source/netbox_vrf: Add
tenant_id
attribute (#112 by @cova-fe) - resource/available_prefix: Add
mark_utilized
attribute (#111 by @cova-fe)
FEATURES
- provider: Now supports NetBox v3.1.3
ENHANCEMENTS
FEATURES
- New Resource:
netbox_ip_range
(#101 by @holmesb) - New Data Source:
netbox_ip_range
(#101 by @holmesb)
FEATURES
- provider: Now supports NetBox v3.0.9
BREAKING CHANGES
- resource/virtual_machine:
vcpus
is now a float to match upstream API
ENHANCEMENTS
FEATURES
ENHANCEMENTS
FEATURES
- provider: Now supports NetBox v2.11.12
BREAKING CHANGES
- resource/virtual_machine:
vcpus
is now a string to match upstream API
ENHANCEMENTS
- New Resource:
netbox_site
(#78)
BUG FIXES
- resource/cluster: Properly set tags when updating (#69)
CHANGES
- Use go 1.17 to fix some builds
ENHANCEMENTS
- Add arm64 builds (#71 by @richardklose)
ENHANCEMENTS
ENHANCEMENTS
- resource/prefix: Add
vrf
andtenant
attribute (#61 by @jeansebastienh)
BUG FIXES
- resource/prefix: Correctly read
prefix
andstatus
(#60 by @jeansebastienh)
FEATURES
- provider: Now supports NetBox v2.10.10
CHANGES
- resource/service:
port
field is now deprecated in favor ofports
field.
ENHANCEMENTS
- New Resource:
netbox_tenant_group
(#48 by @pezhore) - New Data Source:
netbox_tenant_group
(#48 by @pezhore) - data-source/tenant: Add
group_id
attribute (#48 by @pezhore) - resource/tenant: Add
group_id
attribute (#48 by @pezhore) - Documentation (#46 by @pezhore)
ENHANCEMENTS
- New Resource:
netbox_prefix
(#43 by @pezhore) - New Data Source:
netbox_prefix
(#43 by @pezhore) - New Resource:
netbox_available_ip_address
(#43 by @pezhore)
ENHANCEMENTS
FEATURES
- New Resource:
netbox_vrf
(#26 by @rthomson) - New Data Source:
netbox_vrf
(#26 by @rthomson) - New Resource:
netbox_cluster_group
- New Data Source:
netbox_cluster_group
ENHANCEMENTS
- resource/netbox_ip_address: Add
tenant_id
attribute - resource/netbox_cluster: Add
cluster_group_id
attribute
FEATURES
BUG FIXES
FEATURES