Skip to content

Commit 09984e2

Browse files
jvanderaajvanderaa
authored
Release notes and docs. Looks like I put the poetry version change in the last. (#2281)
1 parent 125fae0 commit 09984e2

2 files changed

Lines changed: 234 additions & 4 deletions

File tree

‎docs/admin/release_notes/index.md‎

Lines changed: 41 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,44 @@
11
# Release Notes
22

3-
All the published release notes can be found via the navigation menu. All patch releases are included in the same minor release (e.g. `v1.2`) document.
3+
All the published release notes can be found below. All patch releases are included in the same minor release (e.g. `v1.2`) document.
44

5-
## CHANGELOG
6-
7-
Changelog should be generated using [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)
5+
| Version | Link |
6+
| ------- | ---- |
7+
| v9.0 | [Release Notes](version_9.0.md) |
8+
| v8.1 | [Release Notes](version_8.1.md) |
9+
| v8.0 | [Release Notes](version_8.0.md) |
10+
| v7.9 | [Release Notes](version_7.9.md) |
11+
| v7.8 | [Release Notes](version_7.8.md) |
12+
| v7.7 | [Release Notes](version_7.7.md) |
13+
| v7.6 | [Release Notes](version_7.6.md) |
14+
| v7.5 | [Release Notes](version_7.5.md) |
15+
| v7.4 | [Release Notes](version_7.4.md) |
16+
| v7.3 | [Release Notes](version_7.3.md) |
17+
| v7.2 | [Release Notes](version_7.2.md) |
18+
| v7.1 | [Release Notes](version_7.1.md) |
19+
| v7.0 | [Release Notes](version_7.0.md) |
20+
| v6.0 | [Release Notes](version_6.0.md) |
21+
| v5.0 | [Release Notes](version_5.0.md) |
22+
| v4.4 | [Release Notes](version_4.4.md) |
23+
| v4.3 | [Release Notes](version_4.3.md) |
24+
| v4.2 | [Release Notes](version_4.2.md) |
25+
| v4.1 | [Release Notes](version_4.1.md) |
26+
| v4.0 | [Release Notes](version_4.0.md) |
27+
| v3.5 | [Release Notes](version_3.5.md) |
28+
| v3.4 | [Release Notes](version_3.4.md) |
29+
| v3.3 | [Release Notes](version_3.3.md) |
30+
| v3.2 | [Release Notes](version_3.2.md) |
31+
| v3.1 | [Release Notes](version_3.1.md) |
32+
| v3.0 | [Release Notes](version_3.0.md) |
33+
| v2.3 | [Release Notes](version_2.3.md) |
34+
| v2.2 | [Release Notes](version_2.2.md) |
35+
| v2.1 | [Release Notes](version_2.1.md) |
36+
| v2.0 | [Release Notes](version_2.0.md) |
37+
| v1.7 | [Release Notes](version_1.7.md) |
38+
| v1.6 | [Release Notes](version_1.6.md) |
39+
| v1.5 | [Release Notes](version_1.5.md) |
40+
| v1.4 | [Release Notes](version_1.4.md) |
41+
| v1.3 | [Release Notes](version_1.3.md) |
42+
| v1.2 | [Release Notes](version_1.2.md) |
43+
| v1.1 | [Release Notes](version_1.1.md) |
44+
| v0.9 | [Release Notes](version_0.9.md) |

‎docs/admin/release_notes/version_9.0.md‎

Lines changed: 193 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,193 @@
1+
# Release Notes v9.0.0
2+
3+
## Major Release Highlights
4+
5+
This major release introduces several **breaking changes**, updates Python version support, and adds many new templates and improvements.
6+
7+
## Breaking Changes Summary
8+
9+
The following templates have breaking changes in this release. If you use any of these templates, review the details below and the [Migration Guide](#migration-guide) before upgrading.
10+
11+
| Template | Change Type | Details |
12+
|----------|------------|---------|
13+
| `cisco_ios_show_sdwan_bfd_sessions_table` | Field renamed | `proto` → `protocol` |
14+
| `cisco_ios_show_interfaces_switchport` | Output format changed | `trunking_vlans` now returns individual entries instead of comma-separated strings |
15+
| `aruba_aoscx_show_interface` | New field added | `secondary_ip_address` (list) |
16+
| `fortinet_fnsysctl_ifconfig` | New fields added | `ipv6_address`, `prefix_length` |
17+
| `fortinet_get_system_status` | New field added | `first_ga_patch_build_date` |
18+
| `cisco_ios_show_redundancy` | New fields added | `fast_switchover`, `initial_garp` |
19+
| `mikrotik_routeros_ip_dhcp-server_lease_print_terse_without-paging` | New field added | `class_id` |
20+
| `aruba_aoscx_show_system` | Parsing behavior changed | `vendor` now captures multi-word names |
21+
| `hp_comware_display_interface` | Parsing behavior changed | `untagged_vlan_id` now correctly populates |
22+
| `arista_eos_show_interfaces_transceiver_detail` | Index pattern changed | Minimum abbreviation `tr` → `tra` |
23+
24+
## Breaking Changes
25+
26+
### Python Version Support
27+
28+
* **Dropped Python 3.9 support** - Minimum Python version is now 3.10+
29+
* **Added Python 3.13 support** - Now supports Python 3.10, 3.11, 3.12, and 3.13
30+
31+
### Field Name Changes (Breaking)
32+
33+
* **Cisco IOS SD-WAN BFD Sessions Table**: Renamed `proto` to `protocol` for field name normalization in [#2275](https://github.com/networktocode/ntc-templates/pull/2275)
34+
35+
### Output Format Changes (Breaking)
36+
37+
* **Cisco IOS show interfaces switchport**: `trunking_vlans` list items are now split into individual entries instead of comma-separated strings in [#2271](https://github.com/networktocode/ntc-templates/pull/2271)
38+
- Old: `["1,12,15,31-36,40-42", "900,910,920"]`
39+
- New: `["1", "12", "15", "31-36", "40-42", "900", "910", "920"]`
40+
41+
### New Fields Added to Existing Templates (Schema Changes)
42+
43+
* **Aruba AOS-CX show interface**: New `secondary_ip_address` list field added in [#2274](https://github.com/networktocode/ntc-templates/pull/2274)
44+
* **Fortinet fnsysctl ifconfig**: New `ipv6_address` and `prefix_length` fields added in [#2255](https://github.com/networktocode/ntc-templates/pull/2255)
45+
* **Fortinet get system status**: New `first_ga_patch_build_date` field added in [#2250](https://github.com/networktocode/ntc-templates/pull/2250)
46+
* **Cisco IOS show redundancy**: New `fast_switchover` and `initial_garp` fields added in [#2193](https://github.com/networktocode/ntc-templates/pull/2193)
47+
* **Mikrotik DHCP server lease**: New `class_id` field added in [#2234](https://github.com/networktocode/ntc-templates/pull/2234)
48+
49+
### Parsing Behavior Changes
50+
51+
* **Aruba AOS-CX show system**: `vendor` field now captures multi-word vendor names (e.g., `"HPE"` becomes `"HPE ANW"`) in [#2237](https://github.com/networktocode/ntc-templates/pull/2237)
52+
* **HP Comware display interface**: `untagged_vlan_id` field now correctly captures VLAN IDs that were previously returned as empty strings in [#2197](https://github.com/networktocode/ntc-templates/pull/2197)
53+
* **Arista EOS show interfaces transceiver detail**: Index pattern minimum abbreviation for `transceiver` changed from `tr` to `tra` in [#2230](https://github.com/networktocode/ntc-templates/pull/2230)
54+
55+
## What's Changed
56+
57+
### New Templates
58+
59+
* Add Cisco IOS show running-config interface in [#2246](https://github.com/networktocode/ntc-templates/pull/2246)
60+
* Add Cisco IOS show interfaces status err-disabled in [#2261](https://github.com/networktocode/ntc-templates/pull/2261)
61+
* Add Cisco IOS show sdwan bfd summary in [#2216](https://github.com/networktocode/ntc-templates/pull/2216)
62+
* Add Cisco IOS show sdwan bfd sessions table in [#2217](https://github.com/networktocode/ntc-templates/pull/2217)
63+
* Add Cisco IOS show sdwan control connection in [#2215](https://github.com/networktocode/ntc-templates/pull/2215)
64+
* Add Cisco IOS show sdwan omp peers in [#2214](https://github.com/networktocode/ntc-templates/pull/2214)
65+
* Add Cisco IOS show sdwan tunnel statistics table in [#2213](https://github.com/networktocode/ntc-templates/pull/2213)
66+
* Add Cisco IOS show endpoint-tracker in [#2219](https://github.com/networktocode/ntc-templates/pull/2219)
67+
* Add Cisco IOS show endpoint-tracker tracker-group in [#2218](https://github.com/networktocode/ntc-templates/pull/2218)
68+
* Add Cisco NX-OS show interface breakout in [#2272](https://github.com/networktocode/ntc-templates/pull/2272)
69+
* Add Cisco NX-OS show interface status err-disabled in [#2262](https://github.com/networktocode/ntc-templates/pull/2262)
70+
* Add Cisco NX-OS show interface capabilities in [#2211](https://github.com/networktocode/ntc-templates/pull/2211)
71+
* Add Cisco XR show eigrp neighbors in [#2183](https://github.com/networktocode/ntc-templates/pull/2183)
72+
* Add Cisco Viptela show omp peers in [#2202](https://github.com/networktocode/ntc-templates/pull/2202)
73+
* Add Cisco Viptela show control connections in [#2203](https://github.com/networktocode/ntc-templates/pull/2203)
74+
* Add Juniper JunOS show ethernet-switching interfaces in [#2263](https://github.com/networktocode/ntc-templates/pull/2263)
75+
* Add Arista EOS show interfaces transceiver hardware in [#2230](https://github.com/networktocode/ntc-templates/pull/2230)
76+
* Add Aruba OS show inventory in [#2188](https://github.com/networktocode/ntc-templates/pull/2188)
77+
* Add HP Comware display link-aggregation member-port in [#2210](https://github.com/networktocode/ntc-templates/pull/2210)
78+
* Add Linux bluetoothctl show in [#2212](https://github.com/networktocode/ntc-templates/pull/2212)
79+
* Add Mikrotik ip firewall connection print terse without-paging in [#2232](https://github.com/networktocode/ntc-templates/pull/2232)
80+
* Add Mikrotik ip dns cache print terse without-paging in [#2233](https://github.com/networktocode/ntc-templates/pull/2233)
81+
* Add Mikrotik interface wireguard print terse without-paging in [#2256](https://github.com/networktocode/ntc-templates/pull/2256)
82+
* Add Mikrotik interface wireguard peers print terse without-paging in [#2257](https://github.com/networktocode/ntc-templates/pull/2257)
83+
* Add Palo Alto PAN-OS show routing route in [#2201](https://github.com/networktocode/ntc-templates/pull/2201)
84+
* Add Palo Alto PAN-OS show routing resource in [#2199](https://github.com/networktocode/ntc-templates/pull/2199)
85+
* Add Palo Alto PAN-OS show routing protocol bgp summary in [#2200](https://github.com/networktocode/ntc-templates/pull/2200)
86+
* Add Palo Alto PAN-OS show high-availability path-monitoring in [#2198](https://github.com/networktocode/ntc-templates/pull/2198)
87+
88+
### Enhanced Templates
89+
90+
* Support secondary IP addresses on Aruba AOS-CX show interface in [#2274](https://github.com/networktocode/ntc-templates/pull/2274)
91+
* Capture multi-word vendor names in Aruba AOS-CX show system in [#2237](https://github.com/networktocode/ntc-templates/pull/2237)
92+
* Support dotted-decimal area ID in Cisco IOS show ip ospf interface brief in [#2254](https://github.com/networktocode/ntc-templates/pull/2254)
93+
* Support ipv4 command variant in Cisco XR show ip interface brief in [#2239](https://github.com/networktocode/ntc-templates/pull/2239)
94+
* Add addr6 support to Fortinet fnsysctl ifconfig in [#2255](https://github.com/networktocode/ntc-templates/pull/2255)
95+
* Update Fortinet get system status for v7.4.8 in [#2250](https://github.com/networktocode/ntc-templates/pull/2250)
96+
* Update Cisco NX-OS show module for N9K linecard statuses in [#2264](https://github.com/networktocode/ntc-templates/pull/2264)
97+
* Modify HP Comware display interface for Comware5/7 variations in [#2197](https://github.com/networktocode/ntc-templates/pull/2197)
98+
* Modify HP Comware display ip interface for DHCP assigned IP in [#2207](https://github.com/networktocode/ntc-templates/pull/2207)
99+
* Modify HP Comware display device manuinfo for Comware5/7 in [#2196](https://github.com/networktocode/ntc-templates/pull/2196)
100+
* Update HP Comware display vlan all for Comware5 variations in [#2209](https://github.com/networktocode/ntc-templates/pull/2209)
101+
* Improve Mikrotik ip dhcp-server lease print terse without-paging in [#2234](https://github.com/networktocode/ntc-templates/pull/2234)
102+
* Add new fields to Cisco IOS show redundancy for stackwise in [#2193](https://github.com/networktocode/ntc-templates/pull/2193)
103+
104+
### Bug Fixes
105+
106+
* Fix Cisco IOS show sdwan bfd sessions table header parsing in [#2275](https://github.com/networktocode/ntc-templates/pull/2275)
107+
* Fix Cisco IOS show env power parser in [#2270](https://github.com/networktocode/ntc-templates/pull/2270)
108+
* Fix Cisco IOS traceroute for no VRF info in [#2205](https://github.com/networktocode/ntc-templates/pull/2205)
109+
* Fix Cisco IOS show redundancy for 93xx stackwise in [#2193](https://github.com/networktocode/ntc-templates/pull/2193)
110+
* Fix Cisco NX-OS tunnel support in show interface in [#2267](https://github.com/networktocode/ntc-templates/pull/2267)
111+
* Fix Cisco NX-OS VXLAN nve interfaces in show interface in [#2195](https://github.com/networktocode/ntc-templates/pull/2195)
112+
* Fix Cisco NX-OS interface by matching old FC stats in [#2192](https://github.com/networktocode/ntc-templates/pull/2192)
113+
* Fix Cisco NX-OS show interface for no lead whitespace on uni/multicast pkts in [#2236](https://github.com/networktocode/ntc-templates/pull/2236)
114+
* Fix Cisco ASA show interface output nuances for FPR in [#2224](https://github.com/networktocode/ntc-templates/pull/2224)
115+
* Fix Cisco ASA show interface ip brief for FPR admin down in [#2223](https://github.com/networktocode/ntc-templates/pull/2223)
116+
* Fix Cisco ASA show bgp summary BGP multipath in [#2222](https://github.com/networktocode/ntc-templates/pull/2222)
117+
* Fix Aruba AOS-CX show interface sync devices from network in [#2269](https://github.com/networktocode/ntc-templates/pull/2269)
118+
* Fix Aruba AOS-CX show system vendor line in [#2227](https://github.com/networktocode/ntc-templates/pull/2227)
119+
* Fix Arista EOS show interfaces for VXLAN and no IP addr in [#2235](https://github.com/networktocode/ntc-templates/pull/2235)
120+
* Fix Huawei VRP display lldp neighbor device lines in [#2226](https://github.com/networktocode/ntc-templates/pull/2226)
121+
* Fix Cisco IOS show redundancy for different active/standby location name in [#2225](https://github.com/networktocode/ntc-templates/pull/2225)
122+
123+
## Migration Guide
124+
125+
### Python Version
126+
127+
Ensure you are running Python 3.10 or higher before upgrading. Python 3.9 is no longer supported.
128+
129+
### Field Name Changes
130+
131+
If you are using the following template, update your code to use the new field name:
132+
133+
**Cisco IOS show sdwan bfd sessions table:**
134+
- `proto` -> `protocol`
135+
136+
```python
137+
# Before (v8.x)
138+
result["proto"]
139+
140+
# After (v9.0)
141+
result["protocol"]
142+
```
143+
144+
### Output Format Changes
145+
146+
**Cisco IOS show interfaces switchport - `trunking_vlans`:**
147+
148+
The `trunking_vlans` field now returns individual VLAN/range entries instead of comma-separated strings per line. Update any code that splits on commas:
149+
150+
```python
151+
# Before (v8.x) - each line was a single comma-separated string
152+
# trunking_vlans: ["1,12,15,31-36,40-42,80,85", "900,910,920,930"]
153+
for line in result["trunking_vlans"]:
154+
vlans = line.split(",")
155+
156+
# After (v9.0) - each VLAN/range is its own list entry
157+
# trunking_vlans: ["1", "12", "15", "31-36", "40-42", "80", "85", "900", "910", "920", "930"]
158+
vlans = result["trunking_vlans"] # already split
159+
```
160+
161+
### New Fields in Existing Templates
162+
163+
The following templates now include additional fields in their output. If your code does strict schema validation or exact dictionary comparison, update accordingly:
164+
165+
| Template | New Field(s) |
166+
|----------|-------------|
167+
| `aruba_aoscx_show_interface` | `secondary_ip_address` (list) |
168+
| `fortinet_fnsysctl_ifconfig` | `ipv6_address`, `prefix_length` |
169+
| `fortinet_get_system_status` | `first_ga_patch_build_date` |
170+
| `cisco_ios_show_redundancy` | `fast_switchover`, `initial_garp` |
171+
| `mikrotik_routeros_ip_dhcp-server_lease_print_terse_without-paging` | `class_id` |
172+
173+
### Parsing Behavior Changes
174+
175+
**Aruba AOS-CX show system:**
176+
The `vendor` field now captures multi-word vendor names. If you relied on single-word vendor values, update your logic:
177+
- Old: `"HPE"`
178+
- New: `"HPE ANW"`
179+
180+
**HP Comware display interface:**
181+
The `untagged_vlan_id` field now correctly populates where it previously returned empty strings. Code that checked for empty `untagged_vlan_id` may need adjustment.
182+
183+
**Arista EOS show interfaces transceiver detail:**
184+
The minimum command abbreviation for matching this template changed. If you use `show int tr detail` (2-letter abbreviation for transceiver), use `show int tra detail` instead (minimum 3 letters).
185+
186+
## Statistics
187+
188+
- **Total Changes**: 67 commits
189+
- **New Templates**: 28
190+
- **Enhanced Templates**: 13
191+
- **Bug Fixes**: 16
192+
193+
**Full Changelog**: [v8.1.0...v9.0.0](https://github.com/networktocode/ntc-templates/compare/v8.1.0...v9.0.0)

0 commit comments

Comments
 (0)