Skip to content

enhancement(flow)/Add Support for Additional flow Configuration in Terraform Provider #338

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.

Sign up for GitHub

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 3 commits into
base: main
Choose a base branch
from
+698 −33
Open

enhancement(flow)/Add Support for Additional flow Configuration in Terraform Provider #338

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
164edeb
feat: Add additional flow record and flow exporter configuration supp…
tech-of-all-trades Nov 3, 2025
a9a87aa
fix: Update flow exporter tf_name attributes for clarity
tech-of-all-trades Nov 4, 2025
c4b6794
refactor: Standardize flow exporter attribute names for consistency
tech-of-all-trades Nov 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/data-sources/flow_exporter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,15 @@ data "iosxe_flow_exporter" "example" {
- `option_interface_table_timeout` (Number) Option resend time
- `option_sampler_table` (Boolean) Export Sampler Option
- `option_vrf_table_timeout` (Number) Option resend time
- `source_five_gigabit_ethernet` (String) Five GigabitEthernet
- `source_forty_gigabit_ethernet` (String) Forty GigabitEthernet
- `source_gigabit_ethernet` (String) GigabitEthernet IEEE 802.3z
- `source_hundred_gigabit_ethernet` (String) Hundred GigabitEthernet
- `source_loopback` (Number) Loopback interface
- `source_port_channel` (Number) Ethernet Channel of interfaces
- `source_ten_gigabit_ethernet` (String) Ten Gigabit Ethernet
- `source_twenty_five_gigabit_ethernet` (String) Twenty Five GigabitEthernet
- `source_two_gigabit_ethernet` (String) Two GigabitEthernet
- `source_vlan` (Number) Iosxr Vlans
- `template_data_timeout` (Number) Resend data based on a timeout
- `transport_udp` (Number) UDP transport protocol
6 changes: 6 additions & 0 deletions docs/data-sources/flow_record.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,19 @@ data "iosxe_flow_record" "example" {
- `match_connection_server_ipv4_address` (Boolean) IPv4 address of the flow responder
- `match_connection_server_ipv6_address` (Boolean) IPv6 address of the flow responder
- `match_connection_server_transport_port` (Boolean) Transport port of the flow responder
- `match_datalink_destination_vlan_id` (Boolean) Match destination VLAN ID, available on router platforms (C8K, CSR1K)
- `match_datalink_mac_destination_address_input` (Boolean) Destination MAC address from packet at input
- `match_datalink_mac_source_address_input` (Boolean) Source MAC address from packet at input
- `match_datalink_source_vlan_id` (Boolean) Match source VLAN ID, available on router platforms (C8K, CSR1K)
- `match_datalink_vlan` (String) Match VLAN input/output, available on switch platforms (C9K)
- `match_flow_direction` (Boolean) Direction the flow was monitored in
- `match_flow_observation_point` (Boolean) Observation point ID
- `match_interface_input` (Boolean) The input interface
- `match_ipv4_destination_address` (Boolean) IPv4 destination address
- `match_ipv4_protocol` (Boolean) IPv4 protocol
- `match_ipv4_source_address` (Boolean) IPv4 source address
- `match_ipv4_tos` (Boolean) IPv4 type of service
- `match_ipv4_ttl` (Boolean) IPv4 TTL
- `match_ipv4_version` (Boolean) IP version from IPv4 header
- `match_ipv6_destination_address` (Boolean) IPv6 destination address
- `match_ipv6_protocol` (Boolean) IPv6 payload protocol
Expand Down
11 changes: 11 additions & 0 deletions docs/resources/flow_exporter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,19 @@ resource "iosxe_flow_exporter" "example" {
- `option_sampler_table` (Boolean) Export Sampler Option
- `option_vrf_table_timeout` (Number) Option resend time
- Range: `1`-`86400`
- `source_five_gigabit_ethernet` (String) Five GigabitEthernet
- `source_forty_gigabit_ethernet` (String) Forty GigabitEthernet
- `source_gigabit_ethernet` (String) GigabitEthernet IEEE 802.3z
- `source_hundred_gigabit_ethernet` (String) Hundred GigabitEthernet
- `source_loopback` (Number) Loopback interface
- Range: `0`-`2147483647`
- `source_port_channel` (Number) Ethernet Channel of interfaces
- Range: `0`-`4294967295`
- `source_ten_gigabit_ethernet` (String) Ten Gigabit Ethernet
- `source_twenty_five_gigabit_ethernet` (String) Twenty Five GigabitEthernet
- `source_two_gigabit_ethernet` (String) Two GigabitEthernet
- `source_vlan` (Number) Iosxr Vlans
- Range: `0`-`65535`
- `template_data_timeout` (Number) Resend data based on a timeout
- Range: `1`-`86400`
- `transport_udp` (Number) UDP transport protocol
Expand Down
42 changes: 26 additions & 16 deletions docs/resources/flow_record.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,25 @@ This resource can manage the Flow Record configuration.

```terraform
resource "iosxe_flow_record" "example" {
name = "FNF1"
description = "My flow record"
match_ipv4_source_address = true
match_ipv4_destination_address = true
match_ipv4_protocol = true
match_ipv4_tos = true
match_transport_source_port = true
match_transport_destination_port = true
match_interface_input = true
match_flow_direction = true
collect_interface_output = true
collect_counter_bytes_long = true
collect_counter_packets_long = true
collect_transport_tcp_flags = true
collect_timestamp_absolute_first = true
collect_timestamp_absolute_last = true
name = "FNF1"
description = "My flow record"
match_ipv4_source_address = true
match_ipv4_destination_address = true
match_ipv4_protocol = true
match_ipv4_tos = true
match_transport_source_port = true
match_transport_destination_port = true
match_interface_input = true
match_flow_direction = true
collect_interface_output = true
collect_counter_bytes_long = true
collect_counter_packets_long = true
collect_transport_tcp_flags = true
collect_timestamp_absolute_first = true
collect_timestamp_absolute_last = true
match_datalink_mac_source_address_input = true
match_datalink_mac_destination_address_input = true
match_ipv4_ttl = true
}
```

Expand Down Expand Up @@ -64,13 +67,20 @@ resource "iosxe_flow_record" "example" {
- `match_connection_server_ipv4_address` (Boolean) IPv4 address of the flow responder
- `match_connection_server_ipv6_address` (Boolean) IPv6 address of the flow responder
- `match_connection_server_transport_port` (Boolean) Transport port of the flow responder
- `match_datalink_destination_vlan_id` (Boolean) Match destination VLAN ID, available on router platforms (C8K, CSR1K)
- `match_datalink_mac_destination_address_input` (Boolean) Destination MAC address from packet at input
- `match_datalink_mac_source_address_input` (Boolean) Source MAC address from packet at input
- `match_datalink_source_vlan_id` (Boolean) Match source VLAN ID, available on router platforms (C8K, CSR1K)
- `match_datalink_vlan` (String) Match VLAN input/output, available on switch platforms (C9K)
- Choices: `input`, `output`
- `match_flow_direction` (Boolean) Direction the flow was monitored in
- `match_flow_observation_point` (Boolean) Observation point ID
- `match_interface_input` (Boolean) The input interface
- `match_ipv4_destination_address` (Boolean) IPv4 destination address
- `match_ipv4_protocol` (Boolean) IPv4 protocol
- `match_ipv4_source_address` (Boolean) IPv4 source address
- `match_ipv4_tos` (Boolean) IPv4 type of service
- `match_ipv4_ttl` (Boolean) IPv4 TTL
- `match_ipv4_version` (Boolean) IP version from IPv4 header
- `match_ipv6_destination_address` (Boolean) IPv6 destination address
- `match_ipv6_protocol` (Boolean) IPv6 payload protocol
Expand Down
35 changes: 19 additions & 16 deletions examples/resources/iosxe_flow_record/resource.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,21 @@
resource "iosxe_flow_record" "example" {
name = "FNF1"
description = "My flow record"
match_ipv4_source_address = true
match_ipv4_destination_address = true
match_ipv4_protocol = true
match_ipv4_tos = true
match_transport_source_port = true
match_transport_destination_port = true
match_interface_input = true
match_flow_direction = true
collect_interface_output = true
collect_counter_bytes_long = true
collect_counter_packets_long = true
collect_transport_tcp_flags = true
collect_timestamp_absolute_first = true
collect_timestamp_absolute_last = true
name = "FNF1"
description = "My flow record"
match_ipv4_source_address = true
match_ipv4_destination_address = true
match_ipv4_protocol = true
match_ipv4_tos = true
match_transport_source_port = true
match_transport_destination_port = true
match_interface_input = true
match_flow_direction = true
collect_interface_output = true
collect_counter_bytes_long = true
collect_counter_packets_long = true
collect_transport_tcp_flags = true
collect_timestamp_absolute_first = true
collect_timestamp_absolute_last = true
match_datalink_mac_source_address_input = true
match_datalink_mac_destination_address_input = true
match_ipv4_ttl = true
}
45 changes: 45 additions & 0 deletions gen/definitions/flow_exporter.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,51 @@ attributes:
xpath: source/Loopback
tf_name: source_loopback
example: 123
- yang_name: source/interface-choice/GigabitEthernet/GigabitEthernet
xpath: source/GigabitEthernet
tf_name: source_gigabit_ethernet
exclude_test: true
example: 0/0/1
- yang_name: source/interface-choice/TwoGigabitEthernet/TwoGigabitEthernet
xpath: source/TwoGigabitEthernet
tf_name: source_two_gigabit_ethernet
exclude_test: true
example: 0/0/1
- yang_name: source/interface-choice/FiveGigabitEthernet/FiveGigabitEthernet
xpath: source/FiveGigabitEthernet
tf_name: source_five_gigabit_ethernet
exclude_test: true
example: 0/0/1
- yang_name: source/interface-choice/TenGigabitEthernet/TenGigabitEthernet
xpath: source/TenGigabitEthernet
tf_name: source_ten_gigabit_ethernet
exclude_test: true
example: 0/0/1
- yang_name: source/interface-choice/TwentyFiveGigE/TwentyFiveGigE
xpath: source/TwentyFiveGigE
tf_name: source_twenty_five_gigabit_ethernet
exclude_test: true
example: 0/0/1
- yang_name: source/interface-choice/FortyGigabitEthernet/FortyGigabitEthernet
xpath: source/FortyGigabitEthernet
tf_name: source_forty_gigabit_ethernet
exclude_test: true
example: 0/0/1
- yang_name: source/interface-choice/HundredGigE/HundredGigE
xpath: source/HundredGigE
tf_name: source_hundred_gigabit_ethernet
exclude_test: true
example: 0/0/1
- yang_name: source/interface-choice/Vlan/Vlan
xpath: source/Vlan
tf_name: source_vlan
exclude_test: true
example: 100
- yang_name: source/interface-choice/Port-channel/Port-channel
xpath: source/Port-channel
tf_name: source_port_channel
exclude_test: true
example: 1
- yang_name: transport/udp
example: 655
- yang_name: template/data/timeout
Expand Down
19 changes: 19 additions & 0 deletions gen/definitions/flow_record.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,25 @@ attributes:
- yang_name: collect/connection/server/counter/packets/long
example: true
exclude_test: true
- yang_name: match/datalink/mac/source/address/input
example: true
- yang_name: match/datalink/mac/destination/address/input
example: true
- yang_name: match/datalink/vlan
description: Match VLAN input/output, available on switch platforms (C9K)
example: input
test_tags: [C9000V]
- yang_name: match/datalink/source-vlan-id
description: Match source VLAN ID, available on router platforms (C8K, CSR1K)
example: true
test_tags: [C8000V]
- yang_name: match/datalink/destination-vlan-id
description: Match destination VLAN ID, available on router platforms (C8K, CSR1K)
example: true
test_tags: [C8000V]
exclude_test: true
- yang_name: match/ipv4/ttl
example: true
- yang_name: collect/datalink/mac/source/address/input
example: true
exclude_test: true
Expand Down
36 changes: 36 additions & 0 deletions internal/provider/data_source_iosxe_flow_exporter.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

24 changes: 24 additions & 0 deletions internal/provider/data_source_iosxe_flow_record.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

19 changes: 19 additions & 0 deletions internal/provider/data_source_iosxe_flow_record_test.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading