Skip to content

Update Terraform netbox to v4 #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Jun 12, 2025

This PR contains the following updates:

Package Type Update Change
netbox (source) required_provider major 2.0.5 -> 4.1.0

Release Notes

e-breuninger/terraform-provider-netbox (netbox)

v4.1.0

Compare Source

ENHANCEMENTS

BUG FIXES

  • provider: Now properly detects netbox-docker versions

v4.0.0

Compare Source

BREAKING CHANGES

NetBox 4.2 came with some breaking changes and these are reflected in the provider.

  • resource/netbox_device_interface: Make mac_address attribute read-only
  • resource/netbox_device_interface: Add read-only mac_addresses attribute

ENHANCEMENTS

provider: Now supports NetBox 4.2.x

  • New Resource: netbox_mac_address
  • resource/netbox_cluster: Add location_id, site_group_id, region_id, scope_id and scope_type attributes
  • resource/netbox_prefix: Add location_id, site_group_id and region_id attributes
  • resource/netbox_device_interface: Allow q-in-q value in mode attribute
  • resource/netbox_circuit_termination: Add location_id, site_group_id, region_id, site_id and provider_network_id attributes

BUG FIXES

  • resource/netbox_location: Mark site_id as required

v3.11.1

Compare Source

ENHANCEMENTS

v3.11.0

Compare Source

ENHANCEMENTS

v3.10.0

Compare Source

BREAKING CHANGES

NetBox 4.1 came with some breaking changes and these are reflected in the provider.

  • resource/netbox_event_rule: Replace trigger_on_X attributes with event_types list attribute
  • resource/netbox_racks: Remove type attribute
  • resource/netbox_virtual_disk: Change size_gb attribute to size_mb
  • resource/netbox_virtual_machine: Change disk_size_gb attribute to disk_size_mb
  • resource/netbox_vlan_group: Remove min_vid and max_vid attributes in favor of vid_ranges attribute

ENHANCEMENTS

provider: Now supports NetBox 4.1.x

  • New Resource: netbox_rack_type
  • resource/netbox_racks: Add form_factor attribute

v3.9.3

Compare Source

ENHANCEMENTS

v3.9.2

Compare Source

ENHANCEMENTS

  • provider: Include 4.0.11 in supported versions
  • resource/netbox_ip_address: Add custom_fields attribute (#​638 by @​greatman)
  • resource/netbox_service: Add device_id, description and tags attributes (#​637 by @​STANIAC)
  • data-source/netbox_vrf: Fix a bug where tenant_id was not used (#​643 by @​c3JpbmkK)

v3.9.1

Compare Source

ENHANCEMENTS

provider: Include 4.0.9 and 4.0.10 in supported versions

v3.9.0

Compare Source

ENHANCEMENTS

provider: Now is tested against (= supports) the NetBox 4.0.x range

v3.8.9

Compare Source

ENHANCEMENTS

v3.8.8

Compare Source

ENHANCEMENTS

  • data-source/netbox_prefixes: Add contains and site_id attributes (#​617 by @​tagur87)

BUG FIXES

  • resource/netbox_vpn_tunnel_termination: Fix a interface conversion panic when updating tunnel terminations (#​616 by @​mraerino)

v3.8.7

Compare Source

ENHANCEMENTS

v3.8.6

Compare Source

ENHANCEMENTS

v3.8.5

Compare Source

BUG FIXES

  • All resources with slug attributes now properly allow for up to 100 characters in that attribute

v3.8.4

Compare Source

ENHANCEMENTS

  • data-source/netbox_interfaces: Add limit attribute

v3.8.3

Compare Source

ENHANCEMENTS

  • New Resource: netbox_vpn_tunnel_termination

v3.8.2

Compare Source

ENHANCEMENTS

v3.8.1

Compare Source

ENHANCEMENTS

  • New Resource: netbox_vpn_tunnel_group
  • New Resource: netbox_vpn_tunnel
  • data-source/netbox_virtual_machines: Add platform_slug attribute
  • data-source/netbox_locations: Add parent_id attribute (#​548 by @​GennadySpb)
  • data-source/netbox_location: Add parent_id attribute (#​548 by @​GennadySpb)
  • resource/netbox_location: Add parent_id attribute (#​548 by @​GennadySpb)
  • resource/device_type: Add is_full_depth attribute

v3.8.0

Compare Source

BREAKING CHANGES
Due to a change in NetBox 3.7's behavior regarding Webhooks and the corresponding changes in the API,
the netbox_webhook resource might cause problems with NetBox versions older than 3.7.0.
For all other resources and data sources, the provider should still perform fine with older NetBox versions.

  • resource/netbox_webhook: Removed enabled, trigger_on_create, trigger_on_update, trigger_on_delete, content_types and conditions

ENHANCEMENTS

  • provider: Now officially supports NetBox 3.7
  • New Resource: netbox_event_rule

v3.7.7

Compare Source

BUG FIXES

  • resource/netbox_device: Fix Virtual Chassis Master Update Function for Tag Input (#​532 by @​adelekanley)

v3.7.6

Compare Source

ENHANCEMENTS

  • resource/netbox_webhook: Add additional_headers and conditions attributes (#​505 by @​Ikke)
  • data-source/netbox_vrfs: Allow filtering by tag (#​513 by @​sjurtf)
  • data-source/netbox_virtual_machines: Allow filtering by tenant_id (#​511 by @​sjurtf)
  • data-source/netbox_ip_addresses: Allow filtering by tag (#​510 by @​sjurtf)
  • data-source/netbox_cluster: Allow filtering by cluster_group_id (#​528 by @​Ikke)

BUG FIXES

  • resources/netbox_webhook: Fix a bug where JSON encoding would break drift detection (#​505 by @​Ikke)
  • data-source/netbox_site: Mark optionally searchable attributes as computed as well (#​520 by @​tagur87)

v3.7.5

Compare Source

v3.7.4

Compare Source

ENHANCEMENTS

  • New Resource: netbox_virtual_chassis (#​497 by @​Ikke)
  • resource/netbox_device: Add virtual_chassis_id, virtual_chassis_master, virtual_chassis_position and virtual_chassis_priority attributes (#​500 by @​Ikke)

v3.7.3

Compare Source

ENHANCEMENTS

v3.7.2

Compare Source

ENHANCEMENTS

  • data-source/netbox_location: Allow searching by site_id (#​482 by @​w87x)
  • data-source/netbox_ip_addresses: Allow searching by role, status, vrf and tenant (#​479 by @​sjurtf)
  • data-source/netbox_site: Allow Searching by facility (#​483 by @​ikke)

v3.7.1

Compare Source

ENHANCEMENTS

v3.7.0

Compare Source

BREAKING CHANGES

  • resource/netbox_custom_field: Replace choices attribute with choice_set_id attribute

ENHANCEMENTS

  • provider: Now officially supports NetBox 3.6
  • New Resource: netbox_custom_field_choice_set

v3.6.2

Compare Source

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 and parent_device_interface_id attributes (#​469 by @​bebehei)

BUG FIXES

v3.6.1

Compare Source

FEATURES

v3.6.0

Compare Source

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

v3.5.5

Compare Source

ENHANCEMENTS

  • data-source/netbox_cluster: Allow searching by id field and include custom_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)

v3.5.4

Compare Source

FEATURES

v3.5.3

Compare Source

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 to false
  • resource/netbox_device_interface: Allow setting enabled to false

v3.5.2

Compare Source

FEATURES

ENHANCEMENTS

  • Added description attribute to
    • data-source/netbox_cluster
    • data-source/netbox_devices
    • data-source/netbox_virtual_machines
    • resource/netbox_cluster
    • resource/netbox_device
    • resource/virtual_machine (#​401 by @​tagur87)
  • 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)

v3.5.1

Compare Source

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)

v3.5.0

Compare Source

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 with virtual_machine_interface_id if object_type is currently unset or set to virtualization.vminterface
  • replace interface_id with device_interface_id if object_type is currently set to dcim.interface

ENHANCEMENTS

  • resource/netbox_ip_address: Add virtual_machine_interface_id and device_interface_id attributes
  • resource/netbox_ip_address: Add slaac to the list of valid statuses
  • resource/netbox_ip_address: Add nat_inside_address_id and nat_outside_addresses attributes

BUG FIXES

  • resource/netbox_permission: Fix perpetual drift when constraints is nil (#​432 by @​tagur87)

v3.4.1

Compare Source

ENHANCEMENTS

BUG FIXES

v3.4.0

Compare Source

ENHANCEMENTS

BUG FIXES

  • resource/netbox_primary_ip: Fix a bug where setting the primary ip of a VM unsets the device id

v3.3.3

Compare Source

ENHANCEMENTS

v3.3.2

Compare Source

ENHANCEMENTS

v3.3.1

Compare Source

ENHANCEMENTS

v3.3.0

Compare Source

ENHANCEMENTS

BUG FIXES

v3.2.1

Compare Source

ENHANCEMENTS

BUG FIXES

v3.2.0

Compare Source

ENHANCEMENTS

v3.1.0

Compare Source

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 and shipping_address (#​337 by @​Ikke)
  • resource/netbox_ip_address: IP addresses can now be assigned to devices via the object_type field (#​341 by @​arjenvri)

v3.0.13

Compare Source

ENHANCEMENTS

  • data-source/netbox_prefix: Add site_id attribute (#​320 by @​TGM)

v3.0.12

Compare Source

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

v3.0.11

Compare Source

ENHANCEMENTS

  • resource/netbox_available_ip_address: Add role attribute

BUG FIXES

  • resource/netbox_location: Fix updates of the site_id attribute (#​307 by @​nneul)

v3.0.10

Compare Source

ENHANCEMENTS

  • provider: Add strip_trailing_slashes_from_url attribute

BUG FIXES

v3.0.9

Compare Source

ENHANCEMENTS

v3.0.8

Compare Source

ENHANCEMENTS

BUG FIXES

  • data-source/netbox_prefixes: Fix kernel panic when finding prefixes without vlan or vrf

v3.0.7

Compare Source

ENHANCEMENTS

v3.0.6

Compare Source

ENHANCEMENTS

v3.0.5

Compare Source

ENHANCEMENTS

CHANGES

  • resource/netbox_service: Implement provider-side validation on allowed values. Valid values are tcp, udp and sctp.

v3.0.4

Compare Source

ENHANCEMENTS

CHANGES

  • resource/netbox_prefix: Deprecate cidr attribute in favor of new canonical prefix attribute

v3.0.3

Compare Source

ENHANCEMENTS

v3.0.2

Compare Source

ENHANCEMENTS

  • data-source/netbox_cluster: Add site_id, cluster_type_id, cluster_group_id and tags attribute (#​251 by @​ns1pelle)

v3.0.1

Compare Source

ENHANCEMENTS

  • data-source/netbox_prefix: Add site_id attribute (#​320 by @​TGM)

v3.0.0

Compare Source

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 and custom_fields attributes (#​238 by @​ns1pelle)
  • resource/netbox_token: Add allowed_ips, last_used and expires attributes (#​238 by @​ns1pelle)
  • resource/netbox_device: Add cluster_id attribute (#​238 by @​ns1pelle)

v2.0.7

Compare Source

ENHANCEMENTS


Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@renovate renovate bot force-pushed the renovate/netbox-4.x branch from 5229e05 to 9a82121 Compare July 2, 2025 18:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants