CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[v0.20260310.0] - 2026-03-10

Added

• Configurable device roles (NODE_ROLES, SWITCH_ROLES) via settings.toml with fallback to upstream defaults (#216)
• Auto-detection of numbered site folders for per-site autoconf output using x99 prefix (#216)

Changed

• Autoconf output consolidated under a single prefix split by resource type instead of separate output files (#216)

Dependencies

• typer 0.21.2 → 0.24.1 (#212, #213, #214)
• sushy 5.9.0 → 5.10.0 (#215)
• setuptools 82.0.0 → 82.0.1 (#217)

[v0.20260211.0] - 2026-02-11

Added

• Dependency typing_extensions 4.15.0 (#211)

Dependencies

• python-gilt 2.2.4 → 2.2.5 (#207)
• setuptools 80.10.2 → 82.0.0 (#209)
• typer 0.21.1 → 0.21.2 (#210)

[v0.20260129.0] - 2026-01-29

Dependencies

• setuptools 80.10.1 → 80.10.2 (#204)
• pynetbox 7.6.0 → 7.6.1 (#206)

[v0.20260123.0] - 2026-01-23

Added

• Export archive now includes COMMIT_INFO.txt with git commit hash, date, branch, and message information (#195)

Changed

• Use e2 tools instead of loop devices for export-archive image creation, removing the need for sudo and mount operations (#202)

Dependencies

• gitpython 3.1.45 → 3.1.46 (#200)
• pynetbox 7.5.0 → 7.6.0 (#201)
• setuptools 80.9.0 → 80.10.1 (#203)
• sushy 5.8.0 → 5.9.0 (#197)
• typer 0.20.0 → 0.21.1 (#198, #199)
• yamale 6.0.0 → 6.1.0 (#194)

[v0.20251120.0] - 2025-11-20

Added

• frr_local_pref custom field support to autoconf device interface labeling (#193)
• Python 3.14 classifier (#192)

Dependencies

• sushy 5.7.1 → 5.8.0 (#191)

[v0.20251029.0] - 2025-10-29

Added

• --ignore-errors option to the run command, allowing Ansible tasks to continue execution even when individual tasks fail (#188)
• validate command for NetBox configuration consistency checks, including IP-prefix validation and VRF consistency verification (#189)

[v0.20251028.0] - 2025-10-28

Added

• YAML document start marker (---) to autoconf-generated files (#186)

Fixed

• Stable task ordering in autoconf generation to prevent unnecessary Git diffs (#185)
• YAML indentation for nested lists in autoconf output to comply with yamllint rules (#187)

[v0.20251025.3] - 2025-10-25

Fixed

• PortChannel naming now uses per-switch interface numbers instead of deriving from only the first switch's interfaces (#184)

[v0.20251025.2] - 2025-10-25

Added

• PortChannel autoconf generation for switch-to-switch connections with automatic LAG interface creation and member assignment (#183)

[v0.20251025.1] - 2025-10-25

Fixed

• MAC address extraction in autoconf now includes switches, making it consistent with OOB IP assignment (#182)

[v0.20251025.0] - 2025-10-25

Fixed

• MAC address extraction in autoconf interface assignments now outputs clean strings instead of serialized Python objects (#181)

[v0.20251024.0] - 2025-10-24

Changed

• Include switches in autoconf device IP assignments while keeping them excluded from interface MAC address assignments (#180)

[v0.20251023.0] - 2025-10-23

Fixed

• Cluster loopback IP addresses are now only generated for devices that meet Loopback0 interface criteria (#179)

Dependencies

• ansible-core 2.19.2 → 2.19.3 (#175)
• ansible-runner 2.4.1 → 2.4.2 (#177)
• dynaconf 3.2.11 → 3.2.12 (#176)
• pyyaml 6.0.2 → 6.0.3 (#174)
• typer 0.17.4 → 0.20.0 (#172, #173, #178)

[v0.20250915.0] - 2025-09-15

Dependencies

• ansible-core 2.19.0 → 2.19.2 (#168, #171)
• typer 0.16.1 → 0.17.4 (#169, #170)

[v0.20250825.0] - 2025-08-25

Fixed

• Support both string and integer TOKEN values for NetBox API configuration (#167)

[v0.20250823.0] - 2025-08-23

Changed

• Rename segment parameters from _loopback_network_* and _loopback_offset_* to _segment_loopback_network_* and _segment_loopback_offset_* (#166)

[v0.20250822.0] - 2025-08-22

Added

• Automatic managed-by-osism tag for device interfaces that receive labels through autoconf device interface labeling (#164)

Changed

• Device interface labeling extended to include routers and firewalls in addition to switches (#165)

Dependencies

• sushy 5.7.0 → 5.7.1 (#163)
• typer 0.16.0 → 0.16.1 (#162)

[v0.20250811.2] - 2025-08-11

Added

• Support for direct NetBox API calls via uri task type with path, method, and body parameters (#160)
• YAML syntax validation with meaningful error messages including line/column information (#161)

Fixed

• virtual_chassis module placement in purge command moved from virtualization to dcim where it belongs in NetBox's API structure (#159)

[v0.20250811.1] - 2025-08-11

Added

• --show-playbooks option to run command for previewing generated Ansible playbooks without executing them (#151)
• Support for update_vc_child parameter in device_interface tasks (#152)
• --verbose option to run command for detailed ansible-playbook output with -vvv (#153, #154)
• YAML-formatted output for ansible-playbook using ansible.builtin.default callback with result_format=yaml (#155, #157)
• --parallel option to purge command for concurrent resource deletion (#158)

[v0.20250811.0] - 2025-08-11

Added

• --fail-fast option to run command for early failure exit on first Ansible playbook failure (#147)
• Virtual chassis to purge command resource list (#148)
• Support for register field in YAML resource definitions, enabling Ansible's register functionality for storing task results (#149)
• FHRP groups and FHRP group assignments to purge command resource list (#150)

[v0.20250806.0] - 2025-08-06

Added

• Purge command to delete all managed NetBox resources with dry-run mode, resource type filtering, core resource exclusion, and confirmation prompt (#136)
• --verbose flag to purge command for detailed real-time deletion output (#140)
• Device interface label autoconf based on switch device_interface_label custom field (#143)
• Automatic splitting of autoconf YAML files by resource type for better maintainability (#145)

Changed

• Purge command deletes all resources instead of filtering by managed-by-osism tag (#138)
• Purge command also deletes clusters and cluster types (#139)
• Device interface labeling uses connected_endpoints instead of cable-based discovery (#144)
• Refactor main.py to reduce code duplication and improve modularity by extracting common functionality into reusable helper functions (#146)

Fixed

• Use dcim.interfaces instead of dcim.device_interfaces for correct NetBox API endpoint in purge command (#137)

[v0.20250804.0] - 2025-08-04

Fixed

• AttributeError when VARS is not configured in settings by using getattr() with None default (#135)

[v0.20250803.2] - 2025-08-03

No changes from v0.20250803.0.

[v0.20250803.0] - 2025-08-03

Added

• Cluster-based loopback IP generation in autoconf command, supporting IPv4/IPv6 address assignment for devices with assigned clusters (#131)

Changed

• Always create Loopback0 device interface tasks for eligible devices regardless of whether they already exist in NetBox (#132)
• Use separate API call for cluster config context retrieval instead of direct cluster attribute access (#133)
• Add integer validation for device positions in cluster loopback generation with descriptive warnings for missing or invalid positions (#134)

[v0.20250802.2] - 2025-08-02

Added

• Loopback0 interface generation for eligible devices in autoconf command, output to 299-autoconf.yml (#128)
• hwsku validation requiring sonic_parameters custom field for switch Loopback0 interface creation (#130)

Changed

• Consolidate OOB IP, primary IPv4, and primary IPv6 assignments into single device tasks in autoconf (#127)
• Always generate IP assignment tasks in autoconf regardless of current device state (#125)
• Elevate autoconf assignment logging from debug to info level for better visibility (#126)
• Include switch roles (accessleaf, borderleaf, leaf, spine, etc.) in loopback interface generation (#129)
• Move NETBOX_NODE_ROLES and NETBOX_SWITCH_ROLES constants to global scope to eliminate duplication (#129)

Fixed

• MAC address handling to use interface.mac_address and interface.mac_addresses fields instead of API filter (#124)
• Device role references to use device.role instead of deprecated device.device_role (#124)

[v0.20250802.1] - 2025-08-02

Changed

• Exclude switch devices from autoconf interface analysis, improving performance by avoiding unnecessary switch interface processing (#123)

[v0.20250802.0] - 2025-08-02

Added

• Global variables support with VARS configuration setting and deep merging, allowing shared variables across resource files with local override precedence (#114)
• Directory support for numbered resource organization, enabling 300-devices/ directories alongside 300-devices.yml files (#115)
• --filter-task option replacing --task-filter for consistency, with support for both underscore and hyphen variations (#112)
• autoconf command for automated NetBox configuration generation, handling MAC address, OOB IP, primary IPv4/IPv6 assignments (#121)

Changed

• --limit filter is now applied at the top-level file/directory level rather than to individual files within directories (#115)

Dependencies

• ansible-core 2.18.6 → 2.19.0 (#117, #118)
• GitPython 3.1.44 → 3.1.45 (#119)
• sushy 5.6.0 → 5.7.0 (#116)

[v0.20250622.1] - 2025-06-22

Fixed

• Do not fail when settings.IGNORED_FILES is not defined (#111)

[v0.20250622.0] - 2025-06-22

Added

• Configuration to ignore specific resource files with IGNORED_FILES setting and --include-ignored-files CLI parameter to override (#109)
• Device filtering with --filter-device CLI parameter supporting nested YAML structures like cable terminations (#110)
• Example configuration documentation to README (#108)

Changed

• Sync example device types and resources: replace Edgecore 5835-54T with 5835-54X, rename 7726-32X-O-AC-B to 7726-32X-O-AC-F, add managed-by-metalbox tag and sonic_parameters custom fields to switches (#107)

[v0.20250621.0] - 2025-06-21

Added

• version command to display the application version (#105)

Fixed

• .gitkeep files and other non-directory entries no longer treated as manufacturers in device type library (#106)

[v0.20250529.1] - 2025-05-29

Changed

• Rename import-netbox to import-archive and export to export-archive for naming consistency (#103)
• Replace deprecated pkg_resources with importlib.metadata for version retrieval (#104)

[v0.20250529.0] - 2025-05-29

Added

• Import command for syncing content from netbox-export.tar.gz archives to a configurable destination directory (#101)
• --task-filter option to filter tasks by resource type in the run command (#102)

Changed

• Refactored logger initialization into reusable init_logger() function (#101)

[v0.20250528.1] - 2025-05-28

Added

• Configurable --image-size parameter to export command for ext4 image creation (#98)
• Platform check for ext4 image export to provide clear error on non-Linux systems (#97)
• Example files from osism/testbed repository with Gilt overlay configuration (#99)
• CLAUDE.md file for AI-assisted development guidance (#100)

Changed

• Export command now works without NetBox configuration since it only archives local directories (#96)
• Updated example device types: replaced Cisco manufacturer with Other, added Edgecore 5835-54T-O-AC-F, renamed 7726-32X-O to 7726-32X-O-AC-B, added baremetal device types (#99)
• Updated example resources with tenant support, additional VLANs, prefixes, and expanded testbed node definitions (#99)

Removed

• Base resource file 000-base.yml with device roles and tags (#99)
• Supermicro module type definitions (#99)
• Edgecore 7326-56X-O-AC-B device type (#99)

Dependencies

• python-gilt 2.2.4 added as dev dependency (#99)

[v0.20250528.0] - 2025-05-28

Added

• Option to create a 100MB ext4 image file containing the export tarball via --image flag on export-archive command (#95)

Dependencies

• setuptools 80.8.0 → 80.9.0 (#94)
• typer 0.15.4 → 0.16.0 (#93)

[v0.20250526.0] - 2025-05-26

Added

• Export command to archive NetBox configuration data (devicetypes, moduletypes, resources) as tar.gz (#92)

Changed

• Refactored CLI to use Typer app with subcommands while maintaining backward compatibility (#92)

[v0.20250525.0] - 2025-05-25

Added

• sushy as a dependency for future Redfish MAC address retrieval (#90)

Changed

• Refreshed Zuul CI secrets (#84)

Dependencies

• setuptools 80.3.1 → 80.8.0 (#83, #86, #89)
• typer 0.15.3 → 0.15.4 (#85)
• ansible-core 2.18.5 → 2.18.6 (#87)
• pynetbox 7.4.1 → 7.5.0 (#88)

[v0.20250508.0] - 2025-05-08

Dependencies

• ansible-core 2.18.4 → 2.18.5 (#73)
• dynaconf 3.2.10 → 3.2.11 (#81)
• setuptools 78.1.0 → 80.3.1 (#72, #74, #75, #77, #78, #79, #80)
• typer 0.15.2 → 0.15.3 (#76)

[v0.20250406.2] - 2025-04-06

Changed

• Added debug log messages when devicetype library, moduletype library, or resources are skipped due to no file changes (#70)
• Improved error and debug message wording for clarity (#70)

Fixed

• Swapped devicetype and moduletype library path checks when detecting changed files (#70)
• Exit condition when all processing is skipped now correctly checks skipdtl and skipmtl and skipres instead of the inverted logic (#70)

[v0.20250406.1] - 2025-04-06

Added

• Debug mode option for running with verbose logging output (#68)
• Logging of changed files list when running in debug mode (#69)

[v0.20250406.0] - 2025-04-06

Added

• Support for processing only changed files via --no-always flag using Git diff detection (#67)

Changed

• Fix operator precedence in devicetype/moduletype library condition check (#67)

Dependencies

• ansible-core 2.18.3 → 2.18.4 (#63)
• ansible-runner 2.4.0 → 2.4.1 (#65)
• gitpython 3.1.44 added as new dependency (#66)
• setuptools 76.0.0 → 78.1.0 (#60, #61, #62, #64)

[v0.20250314.0] - 2025-03-14

Dependencies

• jinja2 3.1.5 → 3.1.6 (security) (#56)
• setuptools 75.8.2 → 76.0.0 (#58)

[v0.20250304.0] - 2025-03-04

Added

• Log the name of each handled file (#47)
• Log "Manage resources" step during resource processing (#48)

Changed

• Package requirements.yml and settings.toml.sample as additional data files in the Python package
• Validate configuration options with dynaconf validators and provide defaults where possible
• Wait for NetBox REST API availability instead of just the service endpoint
• Exit on failures during the NetBox availability wait

Fixed

• Negate IGNORE_SSL_ERRORS before passing it to validate_certs to align semantically (osism/netbox-manager#77af0bc)

Dependencies

• ansible-core 2.18.2 → 2.18.3 (#49)
• setuptools 75.8.0 → 75.8.2 (#51)
• typer 0.15.1 → 0.15.2 (#53)

[v0.20250219.3] - 2025-02-19

Fixed

• Default value of --version flag (#45)
• Version callback and SIGINT handler (#46)

[v0.20250219.2] - 2025-02-19

Added

• setuptools to requirements (#43)

Fixed

• callback_version only printing version and exiting when flag is actually set (#44)

[v0.20250219.1] - 2025-02-19

Added

• --version argument to display the current version (#41)
• SIGINT signal handler for graceful exit (#42)

Dependencies

• setuptools 75.8.0 (#41)

[v0.20250219.0] - 2025-02-19

Added

• Parallel execution of resource files with --parallel option (#39)
• Dry run mode with --dryrun option (#39)

Changed

• Group resource files by leading number for dependency-aware execution (#39)

Fixed

• Fix path to images directory in device type library import (#40)

Removed

• natsort dependency, replaced by built-in sorting and grouping (#39)

Dependencies

• ansible-core 2.18.1 → 2.18.2 (#35)
• dynaconf 3.2.6 → 3.2.10 (#38)

[v0.20250109.0] - 2025-01-09

Added

• Support for debug tasks (#31)

Dependencies

• jinja2 3.1.4 → 3.1.5 (#28)
• yamale 5.2.1 → 6.0.0 (#30)

[v0.20241217.0] - 2024-12-17

Dependencies

• ansible-core 2.17.7 → 2.18.1 (#8)

[v0.20241216.0] - 2024-12-16

Added

• Support for state field in resources, allowing resource state management (e.g., absent/present) (#26)

[v0.20241206.1] - 2024-12-06

Fixed

• Paths for device types and module types directories (#25)

[v0.20241206.0] - 2024-12-06

Added

• Module type library support with --skipmtl and --skipres CLI options (#24)
• Support for .secrets.toml in dynaconf configuration (#22)
• Edgecore 7326-56X-O-AC-B device type (#21)
• Manager device and connections to example resources (#20)

Changed

• Renamed device type library directory from example/devicetype-library to example/devicetypes (#24)
• Renamed DTL classes to generic names (DTLRepo → Repo, DTLNetBox → NetBox, DTLLogHandler → LogHandler) (#24)
• Extended README with installation, configuration, and usage instructions (#19)

Dependencies

• loguru 0.7.2 → 0.7.3 (#23)

[v0.20241204.1] - 2024-12-04

Changed

• Use scoped PyPI token in Zuul CI configuration (#16)
• Clean up __init__.py file by removing legacy version handling via pkg_resources (#18)

Fixed

• Fix relative import of dtl module (#17)

[v0.20241204.0] - 2024-12-04

Added

• Initial project setup with CLI application using Typer framework and loguru logging (#3)
• Device Type Library (DTL) import functionality based on netbox-community/Device-Type-Library-Import (#4)
• Configuration management using dynaconf with settings.toml support (#4)
• Example device type definitions for Edgecore 7726-32X-O (#4)
• Ansible playbook execution for managing NetBox resources (#6, #9)
• Custom YAML-based data format for resource definitions (#10)
• CLI options --limit, --wait, and --skipdtl (#11)
• Natural sorting of resource files (#11)
• Variable support in resource files via vars blocks (#11)
• Connection/cable resource examples (#13)
• pyproject.toml with setuptools-git-versioning and Apache 2.0 LICENSE (#14)
• PyPI package publishing via Zuul CI (#15)

Changed

• Renamed project from netbox-connection-manager to netbox-manager (#4)
• Moved device type library examples to example/ directory (#7)

Fixed

• Device type library filter parameter names (devicetype_id → device_type_id, moduletype_id → module_type_id) (#13)

Dependencies

• ansible-core 2.17.7 (new) (#6)
• ansible-runner 2.4.0 (new) (#6)
• Jinja2 3.1.4 (new) (#9)
• natsort 8.4.0 (new) (#11)
• typer 0.14.0 → 0.15.1 (#5, #12)