Add support for BGP maximum-paths for ebgp and ibgp (#333)

Author: seojumper

CHANGELOG.md

@@ -10,6 +10,7 @@
 - Add `iosxe_bgp_template_peer_policy` resource
 - Add `ip_dhcp_relay_information_option_vpn_id` attribute to `iosxe_interface_ethernet` resource and `iosxe_interface_vlan` resource
 - Add `local_routing` attribute to `iosxe_interface_nve` resource and data source
+- Add `ipv4_unicast_maximum_paths_ebgp` and `ipv4_unicast_maximum_paths_ibgp` attributes to the `iosxe_bgp_address_family_ipv4` and `iosxe_bgp_address_family_ipv4_vrf` resources
 
 ## 0.9.3
 

docs/data-sources/bgp_address_family_ipv4.md

@@ -39,6 +39,8 @@ data "iosxe_bgp_address_family_ipv4" "example" {
 - `ipv4_unicast_distance_bgp_external` (Number)
 - `ipv4_unicast_distance_bgp_internal` (Number)
 - `ipv4_unicast_distance_bgp_local` (Number)
+- `ipv4_unicast_maximum_paths_ebgp` (Number) eBGP-multipath
+- `ipv4_unicast_maximum_paths_ibgp` (Number) iBGP-multipath
 - `ipv4_unicast_networks` (Attributes List) Specify a network to announce via BGP (see [below for nested schema](#nestedatt--ipv4_unicast_networks))
 - `ipv4_unicast_networks_mask` (Attributes List) Specify a network to announce via BGP (see [below for nested schema](#nestedatt--ipv4_unicast_networks_mask))
 - `ipv4_unicast_redistribute_connected` (Boolean) Connected

docs/data-sources/bgp_address_family_ipv4_vrf.md

@@ -47,6 +47,8 @@ Read-Only:
 - `ipv4_unicast_distance_bgp_external` (Number)
 - `ipv4_unicast_distance_bgp_internal` (Number)
 - `ipv4_unicast_distance_bgp_local` (Number)
+- `ipv4_unicast_maximum_paths_ebgp` (Number) eBGP-multipath
+- `ipv4_unicast_maximum_paths_ibgp` (Number)
 - `ipv4_unicast_networks` (Attributes List) Specify a network to announce via BGP (see [below for nested schema](#nestedatt--vrfs--ipv4_unicast_networks))
 - `ipv4_unicast_networks_mask` (Attributes List) Specify a network to announce via BGP (see [below for nested schema](#nestedatt--vrfs--ipv4_unicast_networks_mask))
 - `ipv4_unicast_redistribute_connected` (Boolean) Connected

docs/guides/changelog.md

@@ -19,6 +19,7 @@ description: |-
 - Add `iosxe_bgp_template_peer_policy` resource
 - Add `ip_dhcp_relay_information_option_vpn_id` attribute to `iosxe_interface_ethernet` resource and `iosxe_interface_vlan` resource
 - Add `local_routing` attribute to `iosxe_interface_nve` resource and data source
+- Add `ipv4_unicast_maximum_paths_ebgp` and `ipv4_unicast_maximum_paths_ibgp` attributes to the `iosxe_bgp_address_family_ipv4` and `iosxe_bgp_address_family_ipv4_vrf` resources
 
 ## 0.9.3
 

docs/resources/bgp_address_family_ipv4.md

@@ -49,6 +49,8 @@ resource "iosxe_bgp_address_family_ipv4" "example" {
   ipv4_unicast_distance_bgp_external = 20
   ipv4_unicast_distance_bgp_internal = 200
   ipv4_unicast_distance_bgp_local    = 200
+  ipv4_unicast_maximum_paths_ebgp    = 2
+  ipv4_unicast_maximum_paths_ibgp    = 2
 }
 ```
 
@@ -70,6 +72,10 @@ resource "iosxe_bgp_address_family_ipv4" "example" {
 - `ipv4_unicast_distance_bgp_external` (Number) - Range: `1`-`255`
 - `ipv4_unicast_distance_bgp_internal` (Number) - Range: `1`-`255`
 - `ipv4_unicast_distance_bgp_local` (Number) - Range: `1`-`255`
+- `ipv4_unicast_maximum_paths_ebgp` (Number) eBGP-multipath
+  - Range: `1`-`32`
+- `ipv4_unicast_maximum_paths_ibgp` (Number) iBGP-multipath
+  - Range: `1`-`32`
 - `ipv4_unicast_networks` (Attributes List) Specify a network to announce via BGP (see [below for nested schema](#nestedatt--ipv4_unicast_networks))
 - `ipv4_unicast_networks_mask` (Attributes List) Specify a network to announce via BGP (see [below for nested schema](#nestedatt--ipv4_unicast_networks_mask))
 - `ipv4_unicast_redistribute_connected` (Boolean) Connected

docs/resources/bgp_address_family_ipv4_vrf.md

@@ -54,6 +54,8 @@ resource "iosxe_bgp_address_family_ipv4_vrf" "example" {
       ipv4_unicast_distance_bgp_external = 20
       ipv4_unicast_distance_bgp_internal = 200
       ipv4_unicast_distance_bgp_local    = 200
+      ipv4_unicast_maximum_paths_ebgp    = 2
+      ipv4_unicast_maximum_paths_ibgp    = 2
     }
   ]
 }
@@ -93,6 +95,9 @@ Optional:
 - `ipv4_unicast_distance_bgp_external` (Number) - Range: `1`-`255`
 - `ipv4_unicast_distance_bgp_internal` (Number) - Range: `1`-`255`
 - `ipv4_unicast_distance_bgp_local` (Number) - Range: `1`-`255`
+- `ipv4_unicast_maximum_paths_ebgp` (Number) eBGP-multipath
+  - Range: `1`-`32`
+- `ipv4_unicast_maximum_paths_ibgp` (Number) - Range: `1`-`32`
 - `ipv4_unicast_networks` (Attributes List) Specify a network to announce via BGP (see [below for nested schema](#nestedatt--vrfs--ipv4_unicast_networks))
 - `ipv4_unicast_networks_mask` (Attributes List) Specify a network to announce via BGP (see [below for nested schema](#nestedatt--vrfs--ipv4_unicast_networks_mask))
 - `ipv4_unicast_redistribute_connected` (Boolean) Connected

examples/resources/iosxe_bgp_address_family_ipv4/resource.tf

@@ -34,4 +34,6 @@ resource "iosxe_bgp_address_family_ipv4" "example" {
   ipv4_unicast_distance_bgp_external = 20
   ipv4_unicast_distance_bgp_internal = 200
   ipv4_unicast_distance_bgp_local    = 200
+  ipv4_unicast_maximum_paths_ebgp    = 2
+  ipv4_unicast_maximum_paths_ibgp    = 2
 }

examples/resources/iosxe_bgp_address_family_ipv4_vrf/resource.tf

@@ -39,6 +39,8 @@ resource "iosxe_bgp_address_family_ipv4_vrf" "example" {
       ipv4_unicast_distance_bgp_external = 20
       ipv4_unicast_distance_bgp_internal = 200
       ipv4_unicast_distance_bgp_local    = 200
+      ipv4_unicast_maximum_paths_ebgp    = 2
+      ipv4_unicast_maximum_paths_ibgp    = 2
     }
   ]
 }

gen/definitions/bgp_address_family_ipv4.yaml

@@ -77,6 +77,12 @@ attributes:
     example: 200
   - yang_name: ipv4-unicast/distance/bgp/local
     example: 200
+  - yang_name: ipv4-unicast/maximum-paths/ebgp
+    tf_name: ipv4_unicast_maximum_paths_ebgp
+    example: 2
+  - yang_name: ipv4-unicast/maximum-paths/ibgp-leaf
+    tf_name: ipv4_unicast_maximum_paths_ibgp
+    example: 2
 
 test_prerequisites:
   - path: Cisco-IOS-XE-native:native/router/Cisco-IOS-XE-bgp:bgp=65000

gen/definitions/bgp_address_family_ipv4_vrf.yaml

@@ -29,6 +29,7 @@ attributes:
       - yang_name: ipv4-unicast/bgp/router-id/id-choice/ip-id/ip-id
         xpath: ipv4-unicast/bgp/router-id/ip-id
         tf_name: ipv4_unicast_router_id_ip
+        exclude_test: true
         example: 10.1.1.1
         exclude_test: true
       - yang_name: ipv4-unicast/aggregate-address
@@ -111,7 +112,13 @@ attributes:
         example: 200
       - yang_name: ipv4-unicast/distance/bgp/local
         example: 200
-
+      - yang_name: ipv4-unicast/maximum-paths/ebgp
+        tf_name: ipv4_unicast_maximum_paths_ebgp
+        example: 2
+      - yang_name: ipv4-unicast/maximum-paths/ibgp/ibgp-choice/max/max
+        tf_name: ipv4_unicast_maximum_paths_ibgp
+        xpath: ipv4-unicast/maximum-paths/ibgp/max
+        example: 2
 test_prerequisites:
   - path: Cisco-IOS-XE-native:native/vrf/definition=VRF1
     no_delete: true