Merge pull request #491 from acch/479-import-ethernet_port

fix: add node name to `ethernet_port` import identifier to fix import in multi-node clusters

Author: suhasbshekar

CHANGELOG.md

@@ -4,6 +4,9 @@ DOCUMENTATION:
 
 - Corrected `aws` to `aws_lambda` in provider config.
 
+BUG FIXES:
+
+- **netapp-ontap_port**: error when importing VLANs in multi-node clusters ([#479](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/479))
 
 # 2.2.0 (2025-05-01)
 

docs/data-sources/network_ethernet_port.md

@@ -22,6 +22,9 @@ data "netapp-ontap_port" "physical" {
   # required to know which system to interface with
   cx_profile_name = "cluster4"
   name            = "e0a"
+  node = {
+    name = "netapp_single-01"
+  }
 }
 ```
 
@@ -30,6 +33,9 @@ data "netapp-ontap_port" "lag" {
   # required to know which system to interface with
   cx_profile_name = "cluster4"
   name            = "a0a"
+  node = {
+    name = "netapp_single-01"
+  }
 }
 ```
 
@@ -38,6 +44,9 @@ data "netapp-ontap_port" "vlan" {
   # required to know which system to interface with
   cx_profile_name = "cluster4"
   name            = "e0a-100"
+  node = {
+    name = "netapp_single-01"
+  }
 }
 ```
 
@@ -49,6 +58,7 @@ data "netapp-ontap_port" "vlan" {
 
 - `cx_profile_name` (String) Connection profile name
 - `name` (String) Portname, such as e0a, e1b-100 (VLAN on Ethernet), a0c (LAG/ifgrp), a0d-200 (VLAN on LAG/ifgrp), e0a.pv1 (p-VLAN, in select environments only)
+- `node` (Attributes) (see [below for nested schema](#nestedatt--node))
 
 ### Read-Only
 
@@ -58,7 +68,6 @@ data "netapp-ontap_port" "vlan" {
 - `lag` (Attributes) (see [below for nested schema](#nestedatt--lag))
 - `mac_address` (String) Port MAC address
 - `mtu` (Number) MTU of the port in bytes
-- `node` (Attributes) (see [below for nested schema](#nestedatt--node))
 - `rdma_protocols` (Set of String) Supported RDMA offload protocols
 - `reachability` (String) Reachability status of the port
 - `speed` (Number) Link speed in Mbps
@@ -92,9 +101,12 @@ Read-Only:
 
 ### Nested Schema for `node`
 
-Read-Only:
+Required:
 
 - `name` (String) Name of the node on which the port is located
+
+Read-Only:
+
 - `id` (String) Node UUID
 
 <a id="nestedatt--vlan"></a>

docs/resources/network_ethernet_port.md

@@ -143,15 +143,15 @@ Required:
 ## Import
 
 This Resource supports import, which allows you to import existing ethernet port into the state of this resoruce.
-Import require a unique ID composed of the cx_profile_name and port name, separated by a comma.
-id = `cx_profile_name`,`name`
+Import require a unique ID composed of the port name, node name, and cx_profile_name, separated by a comma.
+id = `name`,`node`,`cx_profile_name`
 
 ### Terraform Import
 
 For example
 
 ```shell
- terraform import netapp-ontap_port.example cluster4,e0a-300
+ terraform import netapp-ontap_port.example e0a-300,netapp_single-01,cluster4
 ```
 
 !> The terraform import CLI command can only import resources into the state. Importing via the CLI does not generate configuration. If you want to generate the accompanying configuration for imported resources, use the import block instead.
@@ -165,7 +165,7 @@ First create the block
 ```terraform
 import {
   to = netapp-ontap_port.vlan_import
-  id = "cluster4,e0a-300"
+  id = "e0a-300,netapp_single-01,cluster4"
 }
 ```
 
@@ -180,7 +180,7 @@ This will generate a file called generated.tf, which will contain the configurat
 ```terraform
 # __generated__ by Terraform
 # Please review these resources and move them into your main configuration files.
-# __generated__ by Terraform from "cluster4,e0a-300"
+# __generated__ by Terraform from "e0a-300,netapp_single-01,cluster4"
 resource "netapp-ontap_port" "vlan_import" {
   cx_profile_name = "cluster4"
   type            = "vlan"

examples/data-sources/netapp-ontap_port/data-source.tf

@@ -2,16 +2,25 @@ data "netapp-ontap_port" "physical" {
   # required to know which system to interface with
   cx_profile_name = "cluster4"
   name            = "e0a"
+  node = {
+    name = "netapp_single-01"
+  }
 }
 
 data "netapp-ontap_port" "lag" {
   # required to know which system to interface with
   cx_profile_name = "cluster4"
   name            = "a0a"
+  node = {
+    name = "netapp_single-01"
+  }
 }
 
 data "netapp-ontap_port" "vlan" {
   # required to know which system to interface with
   cx_profile_name = "cluster4"
-  name            = "e0a-100"
+  name            = "e0a-101"
+  node = {
+    name = "netapp_single-01"
+  }
 }

internal/interfaces/network_ethernet_port.go

@@ -151,9 +151,10 @@ func GetEthernetPort(errorHandler *utils.ErrorHandler, r restclient.RestClient,
 
 // Retrieve ethernet port details
 // https://docs.netapp.com/us-en/ontap-restapi/ontap/get-network-ethernet-ports.html
-func GetEthernetPortByName(errorHandler *utils.ErrorHandler, r restclient.RestClient, name string) (*EthernetPortGetDataModelONTAP, error) {
+func GetEthernetPortByName(errorHandler *utils.ErrorHandler, r restclient.RestClient, node, name string) (*EthernetPortGetDataModelONTAP, error) {
 	api := "/network/ethernet/ports/"
 	query := r.NewQuery()
+	query.Set("node.name", node)
 	query.Set("name", name)
 	query.Fields([]string{
 		"broadcast_domain",

internal/provider/networking/network_ethernet_port_data_source.go

@@ -160,15 +160,15 @@ func (d *EthernetPortDataSource) Schema(ctx context.Context, req datasource.Sche
 				Attributes: map[string]schema.Attribute{
 					"name": schema.StringAttribute{
 						MarkdownDescription: "Name of the node on which the port is located",
-						Computed:            true,
+						Required:            true,
 					},
 					"id": schema.StringAttribute{
 						MarkdownDescription: "Node UUID",
 						Computed:            true,
 					},
 				},
 				MarkdownDescription: "Node properties",
-				Computed:            true,
+				Required:            true,
 			},
 			"rdma_protocols": schema.SetAttribute{
 				MarkdownDescription: "Supported RDMA offload protocols",
@@ -257,6 +257,7 @@ func (d *EthernetPortDataSource) Read(ctx context.Context, req datasource.ReadRe
 	restInfo, err := interfaces.GetEthernetPortByName(
 		errorHandler,
 		*client,
+		data.Node.Name.ValueString(),
 		data.Name.ValueString(),
 	)
 	if err != nil {

internal/provider/networking/network_ethernet_port_resource.go

@@ -281,6 +281,7 @@ func (r *EthernetPortResource) Read(ctx context.Context, req resource.ReadReques
 		restInfo, err = interfaces.GetEthernetPortByName(
 			errorHandler,
 			*client,
+			data.Node.Name.ValueString(),
 			data.Name.ValueString(),
 		)
 		if err != nil {
@@ -641,16 +642,17 @@ func (r *EthernetPortResource) ImportState(ctx context.Context, req resource.Imp
 
 	// Extract ethernet_port info from import identifier
 	idParts := strings.Split(req.ID, ",")
-	if len(idParts) != 2 || idParts[0] == "" || idParts[1] == "" {
+	if len(idParts) != 3 || idParts[0] == "" || idParts[1] == "" || idParts[2] == "" {
 		resp.Diagnostics.AddError(
 			"Unexpected Import Identifier",
-			fmt.Sprintf("Expected import identifier with format: cx_profile_name,name, got: %q.", req.ID),
+			fmt.Sprintf("Expected import identifier with format: name,node,cx_profile_name, got: %q.", req.ID),
 		)
 
 		return
 	}
 
 	// Save ethernet_port info to attributes
-	resp.Diagnostics.Append(resp.State.SetAttribute(ctx, path.Root("cx_profile_name"), idParts[0])...)
-	resp.Diagnostics.Append(resp.State.SetAttribute(ctx, path.Root("name"), idParts[1])...)
+	resp.Diagnostics.Append(resp.State.SetAttribute(ctx, path.Root("name"), idParts[0])...)
+	resp.Diagnostics.Append(resp.State.SetAttribute(ctx, path.Root("node").AtName("name"), idParts[1])...)
+	resp.Diagnostics.Append(resp.State.SetAttribute(ctx, path.Root("cx_profile_name"), idParts[2])...)
 }