modify catalystcenter_lan_automation to use V2 LAN Automation Start API (#209)

Author: kuba-mazurkiewicz

CHANGELOG.md

@@ -1,5 +1,6 @@
 ## 0.2.5 (unreleased)
 
+- Modify `catalystcenter_lan_automation` to use V2 LAN Automation Start API, which supports optional auto-stop processing feature based on the provided timeout or a specific device list, or both.
 - Add `catalystcenter_assign_device_to_site` resource. This resource only works with Catalyst Center version 2.3.7.9+
 - Improve delete operations to treat `404 Not Found` responses as successful, ensuring idempotent behavior when resources are already removed
 

docs/data-sources/lan_automation.md

@@ -28,6 +28,9 @@ data "catalystcenter_lan_automation" "example" {
 ### Read-Only
 
 - `discovered_device_site_name_hierarchy` (String) Discovered device site name.
+- `discovery_devices` (Attributes Set) List of specific devices that will be LAN Automated in this session (see [below for nested schema](#nestedatt--discovery_devices))
+- `discovery_level` (Number) Level below primary seed device upto which the new devices will be LAN Automated by this session, level + seed = tier
+- `discovery_timeout` (Number) Discovery timeout in minutes. Until this time, the stop processing will not be triggered.
 - `host_name_file_id` (String) File ID of the CSV file containing the host name list.
 - `host_name_prefix` (String) Host name prefix which shall be assigned to the discovered device.
 - `ip_pools` (Attributes List) The list of IP pools with its name and role. (see [below for nested schema](#nestedatt--ip_pools))
@@ -38,6 +41,17 @@ data "catalystcenter_lan_automation" "example" {
 - `primary_device_management_ip_address` (String) Primary seed management IP address.
 - `redistribute_isis_to_bgp` (Boolean) Advertise LAN Automation summary route into BGP.
 
+<a id="nestedatt--discovery_devices"></a>
+### Nested Schema for `discovery_devices`
+
+Read-Only:
+
+- `device_host_name` (String) Hostname of the device
+- `device_management_ip_address` (String) Management IP Address of the device
+- `device_serial_number` (String) Serial number of the device
+- `device_site_name_hierarchy` (String) Site name hierarchy for the device, must be a child site of the discoveredDeviceSiteNameHierarchy or same if it’s not area type
+
+
 <a id="nestedatt--ip_pools"></a>
 ### Nested Schema for `ip_pools`
 

docs/guides/changelog.md

@@ -9,6 +9,7 @@ description: |-
 
 ## 0.2.5 (unreleased)
 
+- Modify `catalystcenter_lan_automation` to use V2 LAN Automation Start API, which supports optional auto-stop processing feature based on the provided timeout or a specific device list, or both.
 - Add `catalystcenter_assign_device_to_site` resource. This resource only works with Catalyst Center version 2.3.7.9+
 - Improve delete operations to treat `404 Not Found` responses as successful, ensuring idempotent behavior when resources are already removed
 

docs/resources/lan_automation.md

@@ -16,7 +16,6 @@ This resource can Start LAN Automation on resource creation and Stop LAN Automat
 resource "catalystcenter_lan_automation" "example" {
   discovered_device_site_name_hierarchy = "Global/Area1/Area2"
   primary_device_management_ip_address  = "1.2.3.4"
-  peer_device_management_ip_address     = "1.2.3.5"
   primary_device_interface_names        = ["HundredGigE1/0/1"]
   ip_pools = [
     {
@@ -28,6 +27,16 @@ resource "catalystcenter_lan_automation" "example" {
   host_name_prefix         = "TEST"
   isis_domain_password     = "cisco123"
   redistribute_isis_to_bgp = true
+  discovery_level          = 2
+  discovery_timeout        = 20
+  discovery_devices = [
+    {
+      device_serial_number         = "FOC12345678"
+      device_host_name             = "EDGE01"
+      device_site_name_hierarchy   = "Global/Area1/Area2"
+      device_management_ip_address = "10.0.0.1"
+    }
+  ]
 }
 ```
 
@@ -37,14 +46,20 @@ resource "catalystcenter_lan_automation" "example" {
 ### Required
 
 - `discovered_device_site_name_hierarchy` (String) Discovered device site name.
+- `ip_pools` (Attributes List) The list of IP pools with its name and role. (see [below for nested schema](#nestedatt--ip_pools))
 - `primary_device_interface_names` (Set of String) The list of interfaces on primary seed via which the discovered devices are connected.
 - `primary_device_management_ip_address` (String) Primary seed management IP address.
 
 ### Optional
 
+- `discovery_devices` (Attributes Set) List of specific devices that will be LAN Automated in this session (see [below for nested schema](#nestedatt--discovery_devices))
+- `discovery_level` (Number) Level below primary seed device upto which the new devices will be LAN Automated by this session, level + seed = tier
+  - Range: `1`-`5`
+  - Default value: `2`
+- `discovery_timeout` (Number) Discovery timeout in minutes. Until this time, the stop processing will not be triggered.
+  - Range: `20`-`10080`
 - `host_name_file_id` (String) File ID of the CSV file containing the host name list.
 - `host_name_prefix` (String) Host name prefix which shall be assigned to the discovered device.
-- `ip_pools` (Attributes List) The list of IP pools with its name and role. (see [below for nested schema](#nestedatt--ip_pools))
 - `isis_domain_password` (String) ISIS domain password.
 - `multicast_enabled` (Boolean) To enable underlay native multicast.
 - `peer_device_management_ip_address` (String) Secondary seed management IP address.
@@ -63,6 +78,20 @@ Required:
 - `ip_pool_role` (String) Role of the IP pool.
   - Choices: `MAIN_POOL`, `PHYSICAL_LINK_POOL`
 
+
+<a id="nestedatt--discovery_devices"></a>
+### Nested Schema for `discovery_devices`
+
+Required:
+
+- `device_serial_number` (String) Serial number of the device
+
+Optional:
+
+- `device_host_name` (String) Hostname of the device
+- `device_management_ip_address` (String) Management IP Address of the device
+- `device_site_name_hierarchy` (String) Site name hierarchy for the device, must be a child site of the discoveredDeviceSiteNameHierarchy or same if it’s not area type
+
 ## Import
 
 Import is supported using the following syntax:

examples/resources/catalystcenter_lan_automation/resource.tf

@@ -1,7 +1,6 @@
 resource "catalystcenter_lan_automation" "example" {
   discovered_device_site_name_hierarchy = "Global/Area1/Area2"
   primary_device_management_ip_address  = "1.2.3.4"
-  peer_device_management_ip_address     = "1.2.3.5"
   primary_device_interface_names        = ["HundredGigE1/0/1"]
   ip_pools = [
     {
@@ -13,4 +12,14 @@ resource "catalystcenter_lan_automation" "example" {
   host_name_prefix         = "TEST"
   isis_domain_password     = "cisco123"
   redistribute_isis_to_bgp = true
+  discovery_level          = 2
+  discovery_timeout        = 20
+  discovery_devices = [
+    {
+      device_serial_number         = "FOC12345678"
+      device_host_name             = "EDGE01"
+      device_site_name_hierarchy   = "Global/Area1/Area2"
+      device_management_ip_address = "10.0.0.1"
+    }
+  ]
 }

gen/definitions/lan_automation.yaml

@@ -1,9 +1,12 @@
 ---
 name: LAN Automation
-rest_endpoint: /dna/intent/api/v1/lan-automation
+rest_endpoint: /dna/intent/api/v2/lan-automation
+delete_rest_endpoint: /dna/intent/api/v1/lan-automation
 get_rest_endpoint: /dna/intent/api/v1/lan-automation/status
 no_update: true
-id_path: response.id
+id_path: response.taskId
+no_wait: true
+skip_minimum_test: true
 doc_category: LAN Automation
 res_description:
   'This resource can Start LAN Automation on resource creation and Stop LAN Automation on resource deletion'
@@ -30,7 +33,7 @@ attributes:
     tf_name: peer_device_management_ip_address
     type: String
     description: Secondary seed management IP address.
-    example: 1.2.3.5
+    exclude_test: true
   - model_name: primaryDeviceInterfaceNames
     data_path: "0"
     response_data_path: response.0.primaryDeviceInterfaceNames
@@ -41,6 +44,7 @@ attributes:
     example: HundredGigE1/0/1
   - model_name: ipPools
     data_path: "0"
+    mandatory: true
     response_data_path: response.0.ipPools
     type: List
     description: The list of IP pools with its name and role.
@@ -60,7 +64,7 @@ attributes:
         example: MAIN_POOL
   - model_name: multicastEnabled
     data_path: "0"
-    response_data_path: response.0.multicatEnabled
+    response_data_path: response.0.multicastEnabled
     type: Bool
     description: To enable underlay native multicast.
     example: true
@@ -80,6 +84,7 @@ attributes:
   - model_name: isisDomainPwd
     data_path: "0"
     response_data_path: response.0.isisDomainPwd
+    write_only: true
     tf_name: isis_domain_password
     type: String
     description: ISIS domain password.
@@ -90,3 +95,45 @@ attributes:
     type: Bool
     description: Advertise LAN Automation summary route into BGP. 
     example: true
+  - model_name: discoveryLevel
+    data_path: "0"
+    response_data_path: response.0.discoveryLevel
+    type: Int64
+    description: Level below primary seed device upto which the new devices will be LAN Automated by this session, level + seed = tier
+    min_int: 1
+    max_int: 5
+    default_value: 2
+    example: 2
+  - model_name: discoveryTimeout
+    data_path: "0"
+    response_data_path: response.0.discoveryTimeout
+    type: Int64
+    description: Discovery timeout in minutes. Until this time, the stop processing will not be triggered.
+    min_int: 20
+    max_int: 10080
+    example: 20
+  - model_name: discoveryDevices
+    data_path: "0"
+    response_data_path: response.0.discoveryDevices
+    type: Set
+    description: List of specific devices that will be LAN Automated in this session
+    attributes:
+      - model_name: deviceSerialNumber
+        type: String
+        mandatory: true
+        id: true
+        description: Serial number of the device
+        example: FOC12345678
+      - model_name: deviceHostName
+        type: String
+        description: Hostname of the device
+        example: EDGE01
+      - model_name: deviceSiteNameHierarchy
+        type: String
+        description: Site name hierarchy for the device, must be a child site of the discoveredDeviceSiteNameHierarchy or same if it’s not area type
+        example: Global/Area1/Area2
+      - model_name: deviceManagementIPAddress
+        tf_name: device_management_ip_address
+        type: String
+        description: Management IP Address of the device
+        example: 10.0.0.1

gen/generator.go

@@ -118,6 +118,7 @@ type YamlConfig struct {
 	UpdateComputed              bool                  `yaml:"update_computed"`
 	RootList                    bool                  `yaml:"root_list"`
 	NoReadPrefix                bool                  `yaml:"no_read_prefix"`
+	NoWait                      bool                  `yaml:"no_wait"`
 	IdPath                      string                `yaml:"id_path"`
 	IdFromQueryPath             string                `yaml:"id_from_query_path"`
 	IdFromQueryPathAttribute    string                `yaml:"id_from_query_path_attribute"`

gen/schema/schema.yaml

@@ -34,6 +34,7 @@ put_id_query_param: str(required=False) # If PUT needs to have specific query pa
 put_no_id: bool(required=False) # Set to true if the PUT request does not require an ID
 put_update_id: bool(required=False) # Set to true if the PUT request updates the ID
 delete_id_query_param: str(required=False) # If DELETE needs to have specific query parameter where ID should be inserted
+no_wait: bool(required=False) # Set to true to indicate that the task should not wait for completion
 minimum_version: str(required=False) # Define a minimum supported version
 ds_description: str(required=False) # Define a data source description
 res_description: str(required=False) # Define a resource description

gen/templates/resource.go

@@ -453,7 +453,7 @@ func (r *{{camelCase .Name}}Resource) Create(ctx context.Context, req resource.C
 	{{- if .PutCreate}}
 	res, err := r.client.Put(plan.getPath() + params, body {{- if .MaxAsyncWaitTime }}, func(r *cc.Req) { r.MaxAsyncWaitTime={{.MaxAsyncWaitTime}} }{{end}}{{- if .Mutex }}, cc.UseMutex{{- end}})
 	{{- else}}
-	res, err := r.client.Post(plan.getPath() + params, body {{- if .MaxAsyncWaitTime }}, func(r *cc.Req) { r.MaxAsyncWaitTime={{.MaxAsyncWaitTime}} }{{end}}{{- if .Mutex }}, cc.UseMutex{{- end}})
+	res, err := r.client.Post(plan.getPath() + params, body {{- if .MaxAsyncWaitTime }}, func(r *cc.Req) { r.MaxAsyncWaitTime={{.MaxAsyncWaitTime}} }{{end}}{{- if .Mutex }}, cc.UseMutex{{- end}}{{- if .NoWait }}, cc.NoWait{{- end}})
 	{{- end}}
 	if err != nil {
 	{{- if .DeviceUnreachabilityWarning}}

internal/provider/data_source_catalystcenter_lan_automation.go

@@ -115,6 +115,38 @@ func (d *LANAutomationDataSource) Schema(ctx context.Context, req datasource.Sch
 				MarkdownDescription: "Advertise LAN Automation summary route into BGP.",
 				Computed:            true,
 			},
+			"discovery_level": schema.Int64Attribute{
+				MarkdownDescription: "Level below primary seed device upto which the new devices will be LAN Automated by this session, level + seed = tier",
+				Computed:            true,
+			},
+			"discovery_timeout": schema.Int64Attribute{
+				MarkdownDescription: "Discovery timeout in minutes. Until this time, the stop processing will not be triggered.",
+				Computed:            true,
+			},
+			"discovery_devices": schema.SetNestedAttribute{
+				MarkdownDescription: "List of specific devices that will be LAN Automated in this session",
+				Computed:            true,
+				NestedObject: schema.NestedAttributeObject{
+					Attributes: map[string]schema.Attribute{
+						"device_serial_number": schema.StringAttribute{
+							MarkdownDescription: "Serial number of the device",
+							Computed:            true,
+						},
+						"device_host_name": schema.StringAttribute{
+							MarkdownDescription: "Hostname of the device",
+							Computed:            true,
+						},
+						"device_site_name_hierarchy": schema.StringAttribute{
+							MarkdownDescription: "Site name hierarchy for the device, must be a child site of the discoveredDeviceSiteNameHierarchy or same if it’s not area type",
+							Computed:            true,
+						},
+						"device_management_ip_address": schema.StringAttribute{
+							MarkdownDescription: "Management IP Address of the device",
+							Computed:            true,
+						},
+					},
+				},
+			},
 		},
 	}
 }