Refactor resource import functionality

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.4.0 (unreleased)
+
+- BREAKING CHANGE: Refactor resource import functionality to use a comma separated list of key attribute values instead of a gNMI path
+
 ## 0.3.2
 
 - Add `route_policy_in` and `route_policy_out` attributes to `iosxr_bgp_neighbor_group` resource and data source
@@ -21,7 +25,6 @@
 - Make `make_before_break_delay` attribute of `iosxr_mpls_ldp` resource optional
 - Make various `iosxr_key_chain` resource attributes optional
 
-
 ## 0.3.0
 
 - Add `ipv4_verify_unicast_source_reachable_via` and `ipv4_access_group` attributes to `iosxr_interface` resource and data source

docs/guides/changelog.md

@@ -7,6 +7,10 @@ description: |-
 
 # Changelog
 
+## 0.4.0 (unreleased)
+
+- BREAKING CHANGE: Refactor resource import functionality to use a comma separated list of key attribute values instead of a gNMI path
+
 ## 0.3.2
 
 - Add `route_policy_in` and `route_policy_out` attributes to `iosxr_bgp_neighbor_group` resource and data source
@@ -30,7 +34,6 @@ description: |-
 - Make `make_before_break_delay` attribute of `iosxr_mpls_ldp` resource optional
 - Make various `iosxr_key_chain` resource attributes optional
 
-
 ## 0.3.0
 
 - Add `ipv4_verify_unicast_source_reachable_via` and `ipv4_access_group` attributes to `iosxr_interface` resource and data source

docs/resources/as_path_set.md

@@ -40,5 +40,5 @@ resource "iosxr_as_path_set" "example" {
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_as_path_set.example "Cisco-IOS-XR-um-route-policy-cfg:/routing-policy/sets/as-path-sets/as-path-set[set-name=TEST1]"
+terraform import iosxr_as_path_set.example "<set_name>"
 ```

docs/resources/banner.md

@@ -41,5 +41,5 @@ resource "iosxr_banner" "example" {
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_banner.example "Cisco-IOS-XR-um-banner-cfg:/banners/banner[banner-type=login]"
+terraform import iosxr_banner.example "<banner_type>"
 ```

docs/resources/bfd.md

@@ -137,5 +137,5 @@ Required:
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_bfd.example "Cisco-IOS-XR-um-bfd-sbfd-cfg:/bfd"
+terraform import iosxr_bfd.example ""
 ```

docs/resources/bgp_as_format.md

@@ -37,5 +37,5 @@ resource "iosxr_bgp_as_format" "example" {
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_bgp_as_format.example "Cisco-IOS-XR-um-router-bgp-cfg:/as-format"
+terraform import iosxr_bgp_as_format.example ""
 ```

docs/resources/cdp.md

@@ -47,5 +47,5 @@ resource "iosxr_cdp" "example" {
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_cdp.example "Cisco-IOS-XR-um-cdp-cfg:/cdp"
+terraform import iosxr_cdp.example ""
 ```

docs/resources/class_map_qos.md

@@ -48,5 +48,5 @@ resource "iosxr_class_map_qos" "example" {
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_class_map_qos.example "Cisco-IOS-XR-um-policymap-classmap-cfg:/class-map/type/qos[class-map-name=TEST]"
+terraform import iosxr_class_map_qos.example "<class_map_name>"
 ```

docs/resources/community_set.md

@@ -40,5 +40,5 @@ resource "iosxr_community_set" "example" {
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_community_set.example "Cisco-IOS-XR-um-route-policy-cfg:/routing-policy/sets/community-sets/community-set[set-name=TEST11]"
+terraform import iosxr_community_set.example "<set_name>"
 ```

docs/resources/domain.md

@@ -116,5 +116,5 @@ Required:
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_domain.example "Cisco-IOS-XR-um-domain-cfg:/domain"
+terraform import iosxr_domain.example ""
 ```

docs/resources/domain_vrf.md

@@ -119,5 +119,5 @@ Required:
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_domain_vrf.example "Cisco-IOS-XR-um-domain-cfg:/domain/vrfs/vrf[vrf-name=TEST-VRF]"
+terraform import iosxr_domain_vrf.example "<vrf_name>"
 ```

docs/resources/error_disable_recovery.md

@@ -95,5 +95,5 @@ resource "iosxr_error_disable_recovery" "example" {
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_error_disable_recovery.example "Cisco-IOS-XR-um-error-disable-cfg:/error-disable/recovery/cause"
+terraform import iosxr_error_disable_recovery.example ""
 ```

docs/resources/esi_set.md

@@ -40,5 +40,5 @@ resource "iosxr_esi_set" "example" {
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_esi_set.example "Cisco-IOS-XR-um-route-policy-cfg:/routing-policy/sets/esi-sets/esi-set[set-name=POLICYSET]"
+terraform import iosxr_esi_set.example "<set_name>"
 ```

docs/resources/evpn.md

@@ -37,5 +37,5 @@ resource "iosxr_evpn" "example" {
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_evpn.example "Cisco-IOS-XR-um-l2vpn-cfg:/evpn"
+terraform import iosxr_evpn.example ""
 ```

docs/resources/evpn_evi.md

@@ -157,5 +157,5 @@ Required:
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_evpn_evi.example "Cisco-IOS-XR-um-l2vpn-cfg:/evpn/evis/evi[vpn-id=1234]"
+terraform import iosxr_evpn_evi.example "<vpn_id>"
 ```

docs/resources/evpn_group.md

@@ -54,5 +54,5 @@ Required:
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_evpn_group.example "Cisco-IOS-XR-um-l2vpn-cfg:/evpn/groups/group[group-name=1]"
+terraform import iosxr_evpn_group.example "<group_id>"
 ```

docs/resources/evpn_interface.md

@@ -57,5 +57,5 @@ resource "iosxr_evpn_interface" "example" {
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_evpn_interface.example "Cisco-IOS-XR-um-l2vpn-cfg:/evpn/interface/interface[interface-name=Bundle-Ether12]"
+terraform import iosxr_evpn_interface.example "<interface_name>"
 ```

docs/resources/evpn_segment_routing_srv6_evi.md

@@ -126,5 +126,5 @@ Required:
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_evpn_segment_routing_srv6_evi.example "Cisco-IOS-XR-um-l2vpn-cfg:/evpn/evis/segment-routing/srv6/evi[vpn-id=1235]"
+terraform import iosxr_evpn_segment_routing_srv6_evi.example "<vpn_id>"
 ```

docs/resources/extcommunity_cost_set.md

@@ -40,5 +40,5 @@ resource "iosxr_extcommunity_cost_set" "example" {
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_extcommunity_cost_set.example "Cisco-IOS-XR-um-route-policy-cfg:/routing-policy/sets/extended-community-cost-sets/extended-community-cost-set[set-name=COST2]"
+terraform import iosxr_extcommunity_cost_set.example "<set_name>"
 ```

docs/resources/extcommunity_opaque_set.md

@@ -40,5 +40,5 @@ resource "iosxr_extcommunity_opaque_set" "example" {
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_extcommunity_opaque_set.example "Cisco-IOS-XR-um-route-policy-cfg:/routing-policy/sets/extended-community-opaque-sets/extended-community-opaque-set[set-name=BLUE]"
+terraform import iosxr_extcommunity_opaque_set.example "<set_name>"
 ```

docs/resources/extcommunity_rt_set.md

@@ -40,5 +40,5 @@ resource "iosxr_extcommunity_rt_set" "example" {
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_extcommunity_rt_set.example "Cisco-IOS-XR-um-route-policy-cfg:/routing-policy/sets/extended-community-rt-sets/extended-community-rt-set[set-name=ROUTE1]"
+terraform import iosxr_extcommunity_rt_set.example "<set_name>"
 ```

docs/resources/extcommunity_soo_set.md

@@ -40,5 +40,5 @@ resource "iosxr_extcommunity_soo_set" "example" {
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_extcommunity_soo_set.example "Cisco-IOS-XR-um-route-policy-cfg:/routing-policy/sets/extended-community-soo-sets/extended-community-soo-set[set-name=SITE1]"
+terraform import iosxr_extcommunity_soo_set.example "<set_name>"
 ```

docs/resources/flow_exporter_map.md

@@ -81,5 +81,5 @@ resource "iosxr_flow_exporter_map" "example" {
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_flow_exporter_map.example "Cisco-IOS-XR-um-flow-cfg:/flow/exporter-maps/exporter-map[exporter-map-name=TEST]"
+terraform import iosxr_flow_exporter_map.example "<name>"
 ```

docs/resources/flow_monitor_map.md

@@ -166,5 +166,5 @@ Required:
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_flow_monitor_map.example "Cisco-IOS-XR-um-flow-cfg:/flow/monitor-map/monitor-maps/monitor-map[monitor-map-name=monitor_map1]"
+terraform import iosxr_flow_monitor_map.example "<name>"
 ```

docs/resources/flow_sampler_map.md

@@ -44,5 +44,5 @@ resource "iosxr_flow_sampler_map" "example" {
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_flow_sampler_map.example "Cisco-IOS-XR-um-flow-cfg:/sampler-maps/sampler-map[sampler-map-name=sampler_map1]"
+terraform import iosxr_flow_sampler_map.example "<name>"
 ```

docs/resources/fpd.md

@@ -43,5 +43,5 @@ resource "iosxr_fpd" "example" {
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_fpd.example "Cisco-IOS-XR-um-fpd-cfg:/fpd"
+terraform import iosxr_fpd.example ""
 ```

docs/resources/hostname.md

@@ -35,5 +35,5 @@ resource "iosxr_hostname" "example" {
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_hostname.example "Cisco-IOS-XR-um-hostname-cfg:/hostname"
+terraform import iosxr_hostname.example ""
 ```

docs/resources/interface.md

@@ -272,5 +272,5 @@ Required:
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_interface.example "Cisco-IOS-XR-um-interface-cfg:/interfaces/interface[interface-name=GigabitEthernet0/0/0/1]"
+terraform import iosxr_interface.example "<interface_name>"
 ```

docs/resources/ipv4_access_list.md

@@ -294,5 +294,5 @@ Optional:
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_ipv4_access_list.example "Cisco-IOS-XR-um-ipv4-access-list-cfg:/ipv4/access-lists/access-list[access-list-name=ACCESS1]"
+terraform import iosxr_ipv4_access_list.example "<access_list_name>"
 ```

docs/resources/ipv4_access_list_options.md

@@ -42,5 +42,5 @@ resource "iosxr_ipv4_access_list_options" "example" {
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_ipv4_access_list_options.example "Cisco-IOS-XR-um-ipv4-access-list-cfg:/ipv4/access-list-options"
+terraform import iosxr_ipv4_access_list_options.example ""
 ```

docs/resources/ipv4_prefix_list.md

@@ -73,5 +73,5 @@ Optional:
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_ipv4_prefix_list.example "Cisco-IOS-XR-um-ipv4-prefix-list-cfg:/ipv4/prefix-lists/prefix-list[prefix-list-name=LIST1]"
+terraform import iosxr_ipv4_prefix_list.example "<prefix_list_name>"
 ```

docs/resources/ipv6.md

@@ -63,5 +63,5 @@ resource "iosxr_ipv6" "example" {
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_ipv6.example "Cisco-IOS-XR-um-ipv6-cfg:/ipv6"
+terraform import iosxr_ipv6.example ""
 ```

docs/resources/ipv6_access_list.md

@@ -253,5 +253,5 @@ Optional:
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_ipv6_access_list.example "Cisco-IOS-XR-um-ipv6-access-list-cfg:/ipv6/access-lists/access-list[access-list-name=TEST1]"
+terraform import iosxr_ipv6_access_list.example "<access_list_name>"
 ```

docs/resources/ipv6_access_list_options.md

@@ -42,5 +42,5 @@ resource "iosxr_ipv6_access_list_options" "example" {
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_ipv6_access_list_options.example "Cisco-IOS-XR-um-ipv6-access-list-cfg:/ipv6/access-list-options"
+terraform import iosxr_ipv6_access_list_options.example ""
 ```

docs/resources/ipv6_prefix_list.md

@@ -74,5 +74,5 @@ Optional:
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_ipv6_prefix_list.example "Cisco-IOS-XR-um-ipv6-prefix-list-cfg:/ipv6/prefix-lists/prefix-list[prefix-list-name=LIST1]"
+terraform import iosxr_ipv6_prefix_list.example "<prefix_list_name>"
 ```

docs/resources/key_chain.md

@@ -99,5 +99,5 @@ Optional:
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_key_chain.example "Cisco-IOS-XR-um-key-chain-cfg:/key/chains/chain[key-chain-name=KEY11]"
+terraform import iosxr_key_chain.example "<name>"
 ```

docs/resources/l2vpn.md

@@ -56,5 +56,5 @@ Required:
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_l2vpn.example "Cisco-IOS-XR-um-l2vpn-cfg:/l2vpn"
+terraform import iosxr_l2vpn.example ""
 ```

docs/resources/l2vpn_bridge_group.md

@@ -40,5 +40,5 @@ resource "iosxr_l2vpn_bridge_group" "example" {
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_l2vpn_bridge_group.example "Cisco-IOS-XR-um-l2vpn-cfg:/l2vpn/bridge/groups/group[group-name=BG123]"
+terraform import iosxr_l2vpn_bridge_group.example "<group_name>"
 ```

docs/resources/l2vpn_bridge_group_bridge_domain.md

@@ -108,5 +108,5 @@ Required:
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_l2vpn_bridge_group_bridge_domain.example "Cisco-IOS-XR-um-l2vpn-cfg:/l2vpn/bridge/groups/group[group-name=BG123]/bridge-domains/bridge-domain[bridge-domain-name=BD123]"
+terraform import iosxr_l2vpn_bridge_group_bridge_domain.example "<bridge_group_name>,<bridge_domain_name>"
 ```

docs/resources/l2vpn_pw_class.md

@@ -62,5 +62,5 @@ resource "iosxr_l2vpn_pw_class" "example" {
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_l2vpn_pw_class.example "Cisco-IOS-XR-um-l2vpn-cfg:/l2vpn/pw-classes/pw-class[pw-class-name=PWC1]"
+terraform import iosxr_l2vpn_pw_class.example "<name>"
 ```

docs/resources/l2vpn_xconnect_group_p2p.md

@@ -144,5 +144,5 @@ Optional:
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_l2vpn_xconnect_group_p2p.example "Cisco-IOS-XR-um-l2vpn-cfg:/l2vpn/xconnect/groups/group[group-name=P2P]/p2ps/p2p[p2p-xconnect-name=XC]"
+terraform import iosxr_l2vpn_xconnect_group_p2p.example "<group_name>,<p2p_xconnect_name>"
 ```

docs/resources/lacp.md

@@ -40,5 +40,5 @@ resource "iosxr_lacp" "example" {
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_lacp.example "Cisco-IOS-XR-um-lacp-cfg:/lacp/system"
+terraform import iosxr_lacp.example ""
 ```

docs/resources/lldp.md

@@ -61,5 +61,5 @@ resource "iosxr_lldp" "example" {
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_lldp.example "Cisco-IOS-XR-um-lldp-cfg:/lldp"
+terraform import iosxr_lldp.example ""
 ```

docs/resources/logging.md

@@ -64,5 +64,5 @@ resource "iosxr_logging" "example" {
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_logging.example "Cisco-IOS-XR-um-logging-cfg:/logging"
+terraform import iosxr_logging.example ""
 ```

docs/resources/logging_source_interface.md

@@ -51,5 +51,5 @@ Required:
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_logging_source_interface.example "Cisco-IOS-XR-um-logging-cfg:/logging/source-interfaces/source-interface[source-interface-name=Loopback0]"
+terraform import iosxr_logging_source_interface.example "<name>"
 ```

docs/resources/logging_vrf.md

@@ -91,5 +91,5 @@ Optional:
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_logging_vrf.example "Cisco-IOS-XR-um-logging-cfg:/logging/vrfs/vrf[vrf-name=default]"
+terraform import iosxr_logging_vrf.example "<vrf_name>"
 ```

docs/resources/mpls_ldp.md

@@ -116,5 +116,5 @@ Optional:
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_mpls_ldp.example "Cisco-IOS-XR-um-mpls-ldp-cfg:/mpls/ldp"
+terraform import iosxr_mpls_ldp.example ""
 ```

docs/resources/mpls_oam.md

@@ -47,5 +47,5 @@ resource "iosxr_mpls_oam" "example" {
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_mpls_oam.example "Cisco-IOS-XR-um-mpls-oam-cfg:/mpls"
+terraform import iosxr_mpls_oam.example ""
 ```

docs/resources/mpls_traffic_eng.md

@@ -37,5 +37,5 @@ resource "iosxr_mpls_traffic_eng" "example" {
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_mpls_traffic_eng.example "Cisco-IOS-XR-um-mpls-te-cfg:/mpls"
+terraform import iosxr_mpls_traffic_eng.example ""
 ```

docs/resources/ntp.md

@@ -401,5 +401,5 @@ Required:
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_ntp.example "Cisco-IOS-XR-um-ntp-cfg:/ntp"
+terraform import iosxr_ntp.example ""
 ```

docs/resources/pce.md

@@ -76,5 +76,5 @@ Required:
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_pce.example "Cisco-IOS-XR-um-pce-cfg:/pce"
+terraform import iosxr_pce.example ""
 ```

docs/resources/policy_map_qos.md

@@ -98,5 +98,5 @@ Required:
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_policy_map_qos.example "Cisco-IOS-XR-um-policymap-classmap-cfg:/policy-map/type/qos[policy-map-name=PM1]"
+terraform import iosxr_policy_map_qos.example "<policy_map_name>"
 ```

docs/resources/prefix_set.md

@@ -40,5 +40,5 @@ resource "iosxr_prefix_set" "example" {
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_prefix_set.example "Cisco-IOS-XR-um-route-policy-cfg:/routing-policy/sets/prefix-sets/prefix-set[set-name=PREFIX_SET_1]"
+terraform import iosxr_prefix_set.example "<set_name>"
 ```

docs/resources/rd_set.md

@@ -40,5 +40,5 @@ resource "iosxr_rd_set" "example" {
 Import is supported using the following syntax:
 
 ```shell
-terraform import iosxr_rd_set.example "Cisco-IOS-XR-um-route-policy-cfg:/routing-policy/sets/rd-sets/rd-set[set-name=set1]"
+terraform import iosxr_rd_set.example "<set_name>"
 ```