[New Resource]: Broadcast Domain

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

@@ -0,0 +1,6 @@
+data "netapp-ontap_network_broadcast_domain" "example" {
+  # required to know which system to interface with
+  cx_profile_name = "cluster4"
+  ipspace         = "Default"
+  name            = "Default"
+}

examples/data-sources/netapp-ontap_network_broadcast_domain/provider.tf

@@ -0,0 +1 @@
+../../provider/provider.tf

examples/data-sources/netapp-ontap_network_broadcast_domain/terraform.tfvars

@@ -0,0 +1 @@
+../../provider/terraform.tfvars

examples/data-sources/netapp-ontap_network_broadcast_domain/variables.tf

@@ -0,0 +1 @@
+../../provider/variables.tf

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

@@ -0,0 +1,8 @@
+data "netapp-ontap_network_broadcast_domains" "example" {
+  # required to know which system to interface with
+  cx_profile_name = "cluster4"
+  filter = {
+    ipspace = "Default"
+    name    = "*"
+  }
+}

examples/data-sources/netapp-ontap_network_broadcast_domains/provider.tf

@@ -0,0 +1 @@
+../../provider/provider.tf

examples/data-sources/netapp-ontap_network_broadcast_domains/terraform.tfvars

@@ -0,0 +1 @@
+../../provider/terraform.tfvars

examples/data-sources/netapp-ontap_network_broadcast_domains/variables.tf

@@ -0,0 +1 @@
+../../provider/variables.tf

examples/resources/netapp-ontap_network_broadcast_domain/provider.tf

@@ -0,0 +1 @@
+../../provider/provider.tf

examples/resources/netapp-ontap_network_broadcast_domain/resource.tf

@@ -0,0 +1,7 @@
+resource "netapp-ontap_network_broadcast_domain" "example" {
+  # required to know which system to interface with
+  cx_profile_name = "cluster4"
+  ipspace         = "Default"
+  mtu             = 1500
+  name            = "testme"
+}

examples/resources/netapp-ontap_network_broadcast_domain/terraform.tfvars

@@ -0,0 +1 @@
+../../provider/terraform.tfvars

examples/resources/netapp-ontap_network_broadcast_domain/variables.tf

@@ -0,0 +1 @@
+../../provider/variables.tf

internal/interfaces/networking_broadcast_domain.go

@@ -0,0 +1,277 @@
+package interfaces
+
+import (
+	"fmt"
+
+	"github.com/hashicorp/terraform-plugin-log/tflog"
+	"github.com/mitchellh/mapstructure"
+	"github.com/netapp/terraform-provider-netapp-ontap/internal/restclient"
+	"github.com/netapp/terraform-provider-netapp-ontap/internal/utils"
+)
+
+// BroadcastDomainGetDataModelONTAP describes the GET record data model using go types for mapping.
+// https://docs.netapp.com/us-en/ontap-restapi/ontap/get-network-ethernet-broadcast-domains-.html#response
+type BroadcastDomainGetDataModelONTAP struct {
+	IPspace BroadcastDomainIPSpace `mapstructure:"ipspace"`
+	MTU     int64                  `mapstructure:"mtu"`
+	Name    string                 `mapstructure:"name"`
+	Ports   []BroadcastDomainPort  `mapstructure:"ports"`
+	UUID    string                 `mapstructure:"uuid"`
+}
+
+// BroadcastDomainResourceBodyDataModelONTAP describes the body data model using go types for mapping.
+// https://docs.netapp.com/us-en/ontap-restapi/ontap/post-network-ethernet-broadcast-domains.html#request-body
+type BroadcastDomainResourceBodyDataModelONTAP struct {
+	IPspace BroadcastDomainIPSpace `mapstructure:"ipspace,omitempty"`
+	MTU     int64                  `mapstructure:"mtu,omitempty"`
+	Name    string                 `mapstructure:"name,omitempty"`
+	Ports   []BroadcastDomainPort  `mapstructure:"ports,omitempty"`
+	UUID    string                 `mapstructure:"uuid,omitempty"`
+}
+
+// BroadcastDomainIPSpace describes an IP space specifically for broadcast domains.
+type BroadcastDomainIPSpace struct {
+	Name string `mapstructure:"name,omitempty"`
+	UUID string `mapstructure:"uuid,omitempty"`
+}
+
+// BroadcastDomainPort describes an ethernet port specifically for broadcast domains.
+type BroadcastDomainPort struct {
+	Name string              `mapstructure:"name,omitempty"`
+	Node BroadcastDomainNode `mapstructure:"node,omitempty"`
+	UUID string              `mapstructure:"uuid,omitempty"`
+}
+
+// BroadcastDomainNode describes a node specifically for ethernet ports.
+type BroadcastDomainNode struct {
+	Name string `mapstructure:"name,omitempty"`
+	UUID string `mapstructure:"uuid,omitempty"`
+}
+
+// BroadcastDomainDataSourceFilterModel describes filter model.
+type BroadcastDomainDataSourceFilterModel struct {
+	IPspace string `tfsdk:"ipspace"`
+	Name    string `tfsdk:"name"`
+}
+
+// Retrieve broadcast domain details
+// https://docs.netapp.com/us-en/ontap-restapi/ontap/get-network-ethernet-broadcast-domains-.html
+func GetBroadcastDomain(errorHandler *utils.ErrorHandler, r restclient.RestClient, id string) (*BroadcastDomainGetDataModelONTAP, error) {
+	api := "/network/ethernet/broadcast-domains/" + id
+	query := r.NewQuery()
+	query.Fields([]string{
+		"ipspace",
+		"mtu",
+		"name",
+		"ports",
+		"uuid",
+	})
+
+	statusCode, response, err := r.GetNilOrOneRecord(api, query, nil)
+	if err == nil && response == nil {
+		err = fmt.Errorf("no broadcast domain with id '%s' found", id)
+	}
+	if err != nil {
+		return nil, errorHandler.MakeAndReportError(
+			"Error Reading Broadcast Domain Info",
+			fmt.Sprintf("Error on GET %s: %s, statusCode %d.", api, err, statusCode),
+		)
+	}
+
+	var dataONTAP BroadcastDomainGetDataModelONTAP
+	if err := mapstructure.Decode(response, &dataONTAP); err != nil {
+		return nil, errorHandler.MakeAndReportError(
+			fmt.Sprintf("Failed To Decode Response From GET %s", api),
+			fmt.Sprintf("Error: %s, statusCode %d, response %#v.", err, statusCode, response),
+		)
+	}
+
+	tflog.Debug(
+		errorHandler.Ctx,
+		fmt.Sprintf("Read broadcast domain data source: %#v", dataONTAP),
+	)
+
+	return &dataONTAP, nil
+}
+
+// Retrieve broadcast domain details
+// https://docs.netapp.com/us-en/ontap-restapi/ontap/get-network-ethernet-broadcast-domains.html
+func GetBroadcastDomainByName(errorHandler *utils.ErrorHandler, r restclient.RestClient, ipspace, name string) (*BroadcastDomainGetDataModelONTAP, error) {
+	api := "/network/ethernet/broadcast-domains"
+	query := r.NewQuery()
+	query.Set("ipspace", ipspace)
+	query.Set("name", name)
+	query.Fields([]string{
+		"ipspace",
+		"mtu",
+		"name",
+		"ports",
+		"uuid",
+	})
+
+	statusCode, response, err := r.GetNilOrOneRecord(api, query, nil)
+	if err == nil && response == nil {
+		err = fmt.Errorf("no broadcast domain with ipspace '%s' and name '%s' found", ipspace, name)
+	}
+	if err != nil {
+		return nil, errorHandler.MakeAndReportError(
+			"Error Reading Broadcast Domain Info",
+			fmt.Sprintf("Error on GET %s: %s, statusCode %d.", api, err, statusCode),
+		)
+	}
+
+	var dataONTAP BroadcastDomainGetDataModelONTAP
+	if err := mapstructure.Decode(response, &dataONTAP); err != nil {
+		return nil, errorHandler.MakeAndReportError(
+			fmt.Sprintf("Failed To Decode Response From GET %s", api),
+			fmt.Sprintf("Error: %s, statusCode %d, response %#v.", err, statusCode, response),
+		)
+	}
+
+	tflog.Debug(
+		errorHandler.Ctx,
+		fmt.Sprintf("Read broadcast domain data source: %#v", dataONTAP),
+	)
+
+	return &dataONTAP, nil
+}
+
+// Retrieve broadcast domains for the entire cluster
+// https://docs.netapp.com/us-en/ontap-restapi/ontap/get-network-ethernet-broadcast-domains.html
+func GetListBroadcastDomains(errorHandler *utils.ErrorHandler, r restclient.RestClient, filter *BroadcastDomainDataSourceFilterModel) ([]BroadcastDomainGetDataModelONTAP, error) {
+	api := "network/ethernet/broadcast-domains"
+	query := r.NewQuery()
+	query.Fields([]string{
+		"ipspace",
+		"mtu",
+		"name",
+		"ports",
+		"uuid",
+	})
+
+	if filter != nil {
+		if filter.IPspace != "" {
+			query.Set("ipspace", filter.IPspace)
+		}
+		if filter.Name != "" {
+			query.Set("name", filter.Name)
+		}
+	}
+
+	statusCode, response, err := r.GetZeroOrMoreRecords(api, query, nil)
+	if err == nil && response == nil {
+		err = fmt.Errorf("no broadcast domains with ipspace '%s' and name '%s' found", filter.IPspace, filter.Name)
+	}
+	if err != nil {
+		return nil, errorHandler.MakeAndReportError(
+			"Error Reading Broadcast Domains Info",
+			fmt.Sprintf("Error on GET %s: %s, statusCode %d.", api, err, statusCode),
+		)
+	}
+
+	var dataONTAP []BroadcastDomainGetDataModelONTAP
+	for _, info := range response {
+		var record BroadcastDomainGetDataModelONTAP
+		if err := mapstructure.Decode(info, &record); err != nil {
+			return nil, errorHandler.MakeAndReportError(
+				fmt.Sprintf("Failed To Decode Response From GET %s", api),
+				fmt.Sprintf("Error: %s, statusCode %d, info %#v.", err, statusCode, info),
+			)
+		}
+		dataONTAP = append(dataONTAP, record)
+	}
+
+	tflog.Debug(
+		errorHandler.Ctx,
+		fmt.Sprintf("Read broadcast domain data source: %#v", dataONTAP),
+	)
+
+	return dataONTAP, nil
+}
+
+// Create a new broadcast domain
+// https://docs.netapp.com/us-en/ontap-restapi/ontap/post-network-ethernet-broadcast-domains.html
+func CreateBroadcastDomain(errorHandler *utils.ErrorHandler, r restclient.RestClient, body BroadcastDomainResourceBodyDataModelONTAP) (*BroadcastDomainGetDataModelONTAP, error) {
+	api := "/network/ethernet/broadcast-domains"
+	var bodyMap map[string]interface{}
+	if err := mapstructure.Decode(body, &bodyMap); err != nil {
+		return nil, errorHandler.MakeAndReportError(
+			"Error Encoding Broadcast Domain Body",
+			fmt.Sprintf("Error on encoding %s body: %s, body: %#v.", api, err, body),
+		)
+	}
+	query := r.NewQuery()
+	query.Add("return_records", "true")
+
+	statusCode, response, err := r.CallCreateMethod(api, query, bodyMap)
+	if err != nil {
+		return nil, errorHandler.MakeAndReportError(
+			"Error Creating Broadcast Domain",
+			fmt.Sprintf("Error on POST %s: %s, statusCode %d.", api, err, statusCode),
+		)
+	}
+
+	var dataONTAP BroadcastDomainGetDataModelONTAP
+	if err := mapstructure.Decode(response.Records[0], &dataONTAP); err != nil {
+		return nil, errorHandler.MakeAndReportError(
+			"Error Decoding Broadcast Domain Info",
+			fmt.Sprintf("Error on decode broadcast domain info: %s, statusCode %d, response %#v.", err, statusCode, response),
+		)
+	}
+
+	tflog.Debug(
+		errorHandler.Ctx,
+		fmt.Sprintf("Create broadcast domain resource: %#v", dataONTAP),
+	)
+
+	return &dataONTAP, nil
+}
+
+// Update broadcast domain properties
+// https://docs.netapp.com/us-en/ontap-restapi/ontap/patch-network-ethernet-broadcast-domains-.html
+func UpdateBroadcastDomain(errorHandler *utils.ErrorHandler, r restclient.RestClient, body BroadcastDomainResourceBodyDataModelONTAP, id string) error {
+	api := "/network/ethernet/broadcast-domains/" + id
+	var bodyMap map[string]interface{}
+	if err := mapstructure.Decode(body, &bodyMap); err != nil {
+		return errorHandler.MakeAndReportError(
+			"Error Encoding Broadcast Domain Body",
+			fmt.Sprintf("Error on encoding %s body: %s, body: %#v.", api, err, body),
+		)
+	}
+
+	statusCode, _, err := r.CallUpdateMethod(api, nil, bodyMap)
+	if err != nil {
+		return errorHandler.MakeAndReportError(
+			"Error Updating Broadcast Domain",
+			fmt.Sprintf("Error on PATCH %s: %s, statusCode %d.", api, err, statusCode),
+		)
+	}
+
+	tflog.Debug(
+		errorHandler.Ctx,
+		fmt.Sprintf("Update broadcast domain resource: %#v", bodyMap),
+	)
+
+	return nil
+}
+
+// Delete a broadcast domain
+// https://docs.netapp.com/us-en/ontap-restapi/ontap/delete-network-ethernet-broadcast-domains-.html
+func DeleteBroadcastDomain(errorHandler *utils.ErrorHandler, r restclient.RestClient, id string) error {
+	api := "/network/ethernet/broadcast-domains/" + id
+
+	statusCode, _, err := r.CallDeleteMethod(api, nil, nil)
+	if err != nil {
+		return errorHandler.MakeAndReportError(
+			"Error Deleting Broadcast Domain",
+			fmt.Sprintf("Error on DELETE %s: %s, statusCode %d.", api, err, statusCode),
+		)
+	}
+
+	tflog.Debug(
+		errorHandler.Ctx,
+		fmt.Sprintf("Delete broadcast domain resource: %s", id),
+	)
+
+	return nil
+}